From b4dc8105d1d5bf6c297f7fb4e30ccb5de29e7bf6 Mon Sep 17 00:00:00 2001 From: acolytec3 <17355484+acolytec3@users.noreply.github.com> Date: Fri, 21 Feb 2020 11:49:06 -0500 Subject: [PATCH] Add readme updates --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index b41172afd..ca3a93b0f 100644 --- a/README.md +++ b/README.md @@ -165,6 +165,34 @@ cd nimbus # Follow instructions above! ``` +#### Android + +*Experimental* Code can be compiled and run on Android devices + +##### Environment setup + +* Install the [Termux](https://termux.com) app from FDroid or the Google Play store +* Install a [PRoot](https://wiki.termux.com/wiki/PRoot) of your choice following the instructions for your preferred distribution. +Note, the Ubuntu PRoot is known to contain all Nimbus prerequisites compiled on Arm64 architecture (common architecture for Android devices). Depending on the distribution, it may require effort beyond the scope of this guide to get all prerequisites. + +*Assuming Ubuntu PRoot is used* + +```bash +# Install prerequisites +apt install librocksdb-dev libpcre3-dev + +# Clone repo and build Nimbus just like above +git clone https://github.com/status-im/nimbus.git + +cd nimbus + +make + +make nimbus + +build/nimbus +``` + ### Development tips - you can switch the DB backend with a Nim compiler define: