From cf1a88e2f75c0322f4854aa29c8ffce8160b5662 Mon Sep 17 00:00:00 2001
From: Christian Bundy <christianbundy@fraction.io>
Date: Thu, 20 Feb 2020 15:12:38 -0800
Subject: [PATCH] Add Termux install documentation

Problem: The Termux install is new and exciting and there isn't any
documentation on how to experiment with it.

Solution: Add some documentation like we've done with systemd and
Docker so that we can collaborate and figure it out in the repo!
---
 .cspell.json        |  6 ++++++
 docs/install.md     |  2 ++
 docs/with-termux.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 52 insertions(+)
 create mode 100644 docs/with-termux.md

diff --git a/.cspell.json b/.cspell.json
index 121b6ff..adf75b3 100644
--- a/.cspell.json
+++ b/.cspell.json
@@ -10,13 +10,19 @@
     "Machinekit",
     "OSSEC",
     "Pieter",
+    "Termux",
+    "autoconf",
+    "automake",
     "backlinks",
     "christianbundy",
     "dogfood",
     "hyperaxe",
     "hyperscript",
+    "libsodium",
+    "libtool",
     "manyverse",
     "minlength",
+    "mkdir",
     "monokai",
     "msgs",
     "multiserver",
diff --git a/docs/install.md b/docs/install.md
index 0dcadb5..1bc671d 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -8,6 +8,8 @@ If you want to run Oasis in the background, see [`with-systemd.md`](./with-syste
 
 If you want to run Oasis in a container, see [`with-docker.md`](./with-docker.md).
 
+If you want to run Oasis on Android via Termux, see [`with-termux.md`](./with-termux.md).
+
 ## Download
 
 ### HTTPS
diff --git a/docs/with-termux.md b/docs/with-termux.md
new file mode 100644
index 0000000..9067b18
--- /dev/null
+++ b/docs/with-termux.md
@@ -0,0 +1,44 @@
+# With Termux
+
+**Warning:** Experimental.
+
+Use [Termux](https://termux.com/) to run Oasis on Android.
+
+Please note that this is very experimental and very slow.
+
+## Build
+
+Copy and paste the commands below into your terminal and run them.
+
+```shell
+# Install dependencies, some are optional (in case you need to build from source)
+pkg install \
+  autoconf \
+  automake
+  git \
+  libsodium \
+  libtool \
+  make \
+  nodejs \
+  python
+
+# Allow global npm dependencies
+mkdir ~/.npm-global
+npm config set prefix '~/.npm-global'
+echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.profile
+source ~/.profile
+
+# Upgrade npm
+npm install -g npm
+
+# Install Oasis
+npm --global install --no-optional 'fraction/oasis#semver:*'
+```
+
+## Run
+
+Oasis should open in your browser at http://localhost:3000 after you run:
+
+```
+oasis
+```