logos-messaging/logos-messaging-nim
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-nim.git synced 2026-05-11 21:09:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

enhance README and Makefile

Browse Source 
Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
Ivan FB 2026-05-07 15:59:35 +02:00
parent 27ae07adaa
commit fee2b386a6
No known key found for this signature in database
GPG Key ID: DF0C67A04C543270
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@ -42,6 +42,8 @@ endif
##########
## Main ##
##########
# The Makefile automatically bootstraps dependency setup when needed for build and test targets.
# `make update` is an explicit refresh target and is not required manually for normal builds.
.PHONY: all test update clean examples deps nimble install-nim install-nimble
# default target
@ -77,6 +79,8 @@ $(NIMBLEDEPS_STAMP): nimble.lock | waku.nims
$(MAKE) rebuild-nat-libs-nimbledeps
touch $@
# `update` refreshes the local dependency stamp and lockfile.
# Most targets already depend on $(NIMBLEDEPS_STAMP) and will update automatically as needed.
update:
rm -f $(NIMBLEDEPS_STAMP)
$(MAKE) $(NIMBLEDEPS_STAMP)

10
README.md
View File

@ -26,6 +26,13 @@ The standard developer tools, including a C compiler, GNU Make, Bash, and Git. M
You'll also need an installation of Rust and its toolchain (specifically `rustc` and `cargo`).
The easiest way to install these, is using `rustup`:
Supported toolchain versions:
- Nim 2.2.4
- Nimble 0.22.3
These versions are enforced by the repository configuration and the Makefile.
Rust:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
@ -33,8 +40,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
### Wakunode
```bash
# The first `make` invocation will update all Git submodules.
# You'll run `make update` after each `git pull` in the future to keep those submodules updated.
# The first `make` invocation will initialize the local dependency state.
make wakunode2
# Build with custom compilation flags. Do not use NIM_PARAMS unless you know what you are doing.