From 5af2f3a9de7de51ea57cf972089fdc1a2378119c Mon Sep 17 00:00:00 2001 From: liamcottle Date: Sat, 28 Dec 2024 23:23:11 +1300 Subject: [PATCH] move android docs to its own docs file --- README.md | 31 +------------------------ docs/meshchat_on_android_with_termux.md | 31 +++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 30 deletions(-) create mode 100644 docs/meshchat_on_android_with_termux.md diff --git a/README.md b/README.md index f00cbab..b09d6e2 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/meshchat_on_android_with_termux.md b/docs/meshchat_on_android_with_termux.md new file mode 100644 index 0000000..14eedcc --- /dev/null +++ b/docs/meshchat_on_android_with_termux.md @@ -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`.