From 8fce478a1f5087b8a7ea9a7bfeb5cc60f98b3e07 Mon Sep 17 00:00:00 2001 From: pierre Date: Fri, 26 May 2023 00:34:40 +0200 Subject: [PATCH] doc(nc-native-android): add readme --- nym-connect/native/android/README.md | 32 ++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 nym-connect/native/android/README.md diff --git a/nym-connect/native/android/README.md b/nym-connect/native/android/README.md new file mode 100644 index 0000000000..a192ed73b4 --- /dev/null +++ b/nym-connect/native/android/README.md @@ -0,0 +1,32 @@ +## Nym Connect for Android + +### Prerequisites + +_TODO_ + +### Getting started + +Install Android Studio and open the project. + +### Lib Nym socks5 + +This Application needs the native [nym-socks5-listener](https://github.com/nymtech/nym/blob/develop/sdk/lib/socks5-listener/Cargo.toml) +library in order to work. + +To build it, from the root of the repo run + +```shell +cd sdk/lib/socks5-listener/ +./build-android.sh +``` + +To build in release mode + +```shell +RELEASE=true ./build-android.sh +``` + +The shared library for each ABIs will be automatically moved into +`app/src/main/jniLibs/*` directories. + +### Run _TODO_ \ No newline at end of file