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

move android docs to its own docs file

Browse Source
This commit is contained in:
liamcottle
2024-12-28 23:23:11 +13:00
parent 02ae6da2b4
commit 5af2f3a9de
2 changed files with 32 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -191,36 +191,6 @@ options:
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 upgrade
pkg install git
pkg install nodejs-lts
pkg install python-pip
pkg install rust
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
The first time you run this application, a new Reticulum identity is generated and saved to `storage/identity`.
@@ -320,6 +290,7 @@ I build the vite app everytime without hot reload, since MeshChat expects everyt
## Other Installation Methods
- [Running MeshChat on a Raspberry Pi](./docs/meshchat_raspberry_pi.md)
- [Running MeshChat on Android with Termux](./docs/meshchat_on_android_with_termux.md)
## TODO

31
docs/meshchat_on_android_with_termux.md Normal file
View File

@@ -0,0 +1,31 @@
# MeshChat on Android
It's possible to run on Android from source, using [Termux](https://termux.dev/).
You will need to install a few extra dependencies and make a change to `requirements.txt`.
```
pkg upgrade
pkg install git
pkg install nodejs-lts
pkg install python-pip
pkg install rust
pkg install binutils
pkg install build-essential
```
You should now be able to follow the [how to use it](../README.md#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`.