logos-messaging/nim-sds
1
0
Fork 0
mirror of https://github.com/logos-messaging/nim-sds.git synced 2026-01-02 14:13:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #28 from waku-org/update-readme

Browse Source 
chore: update readme with instructions how to build
This commit is contained in:
Ivan FB 2025-09-17 16:20:21 +02:00 committed by GitHub
commit b03e0dcff4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,2 +1,39 @@
# nim-e2e-reliability
Nim implementation of the e2e reliability protocol
# Building
## Android
Download the latest Android NDK. For example, on Ubuntu Intel:
```code
cd ~
wget https://dl.google.com/android/repository/android-ndk-r27c-linux.zip
```
```code
unzip android-ndk-r27c-linux.zip
```
Then, add the following to your ~/.bashrc file:
```code
export ANDROID_NDK_HOME=$HOME/android-ndk-r27c
export PATH=$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin:$PATH
```
Then, use one of the following commands, according to the current architecture:
| Architecture | command |
| arm64 | make libsds-android ARCH=arm64 |
| amd64 | make libsds-android ARCH=amd64 |
| x86 | make libsds-android ARCH=x86 |
At the end of the process, the library will be created in build/libsds.so
## Windows, Linux or MacOS
```code
make libsds
```