RNS-Things/reticulum-meshchatX
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 8 Wiki Activity

add android docs

Browse Source
This commit is contained in:
liamcottle
2024-07-10 21:31:43 +12:00
parent a804e16f3d
commit a5078cb1f8
1 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -169,6 +169,34 @@ options:
Path to a directory for storing databases and config files (default: ./storage) Path to a directory for storing databases and config files (default: ./storage)
``` ```
## Running on Android
It is possible to run on Android from source, using Termux. You will need to install a few extra dependencies and make a change to `requirements.txt`.
```
pkg install git
pkg install rust
pkg install python-pip
pkg install binutils
pkg install build-essential
```
You should now be able to follow the [how to use it](#how-to-use-it) instructions above.
Before running `pip install -r requirements.txt`, you will need to comment out the `cx_freeze` dependency. It failed to build on my Android tablet, and is not actually required for running from source.
```
nano requirements.txt
```
Ensure the `cx_freeze` line is updated to `#cx_freeze`
> Note: Building wheel for cryptography may take a while on Android.
Once MeshChat is running via Termux, open your favourite Android web browser, and navigate to http://localhost:8000
> Note: The default `AutoInterface` may not work on your Android device. You will need to configure another interface such as `TCPClientInterface`.
## Using an existing Reticulum Identity ## Using an existing Reticulum Identity
The first time you run this application, a new Reticulum identity is generated and saved to `storage/identity`. The first time you run this application, a new Reticulum identity is generated and saved to `storage/identity`.