From a5078cb1f8b8600a2458c984a56c1e25aa87d464 Mon Sep 17 00:00:00 2001
From: liamcottle <liam@liamcottle.com>
Date: Wed, 10 Jul 2024 21:31:43 +1200
Subject: [PATCH] add android docs

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index f411d21..8766442 100644
--- a/README.md
+++ b/README.md
@@ -169,6 +169,34 @@ 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 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
 
 The first time you run this application, a new Reticulum identity is generated and saved to `storage/identity`.