From 75421ec82f588be591107bd381e7c7dc82f9bd7b Mon Sep 17 00:00:00 2001 From: caryoscelus Date: Sat, 8 Jan 2022 09:32:27 +0000 Subject: [PATCH] improve source install instruction - use venv - android/termux instructions --- README.md | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 990dac08..1b0eb6e7 100644 --- a/README.md +++ b/README.md @@ -64,17 +64,34 @@ Following links relate to original ZeroNet: ## How to join -### Install from source +### Install from source (recommended) - - clone this repo - - install python3 and pip if needed (the following instructions are for apt-based distributions) - - `sudo apt update` - - `sudo apt install python3-pip` - - `python3 -m pip install -r requirements.txt` - - Start with: `python3 zeronet.py` - - Open the ZeroHello landing page in your browser by navigating to: http://127.0.0.1:43110/ +#### System dependencies -It is recommended to use python environments instead of installing all dependencies globally (TODO: find/write up the detailed instructions) +##### Generic unix-like + +Install autoconf and other basic development tools, python3 and pip. + +##### Apt-based (debian, ubuntu, etc) + - `sudo apt update` + - `sudo apt install python3-pip build-essential` + +##### Android/Termux + - install [Termux](https://termux.com/) + - in Termux install via `pkg install ` + - `pkg update` + - `pkg install python automake autoconf-dev git` (TODO: check fresh installation whether there are more dependencies to install) + +#### Building python dependencies & running + - clone this repo (NOTE: on Android/Termux you should clone it into "home" folder of Termux, because virtual environment cannot live in `storage/`) + - `python3 -m venv venv` (make python virtual environment, the last `venv` is just a name, if you use different you should replace it in later commands) + - `source venv/bin/activate` (activate environment) + - `python3 -m pip install -r requirements.txt` (install dependencies) + - `python3 zeronet.py` (**run zeronet-conservancy!**) + - open the landing page in your browser by navigating to: http://127.0.0.1:43110/ + - to start it again from fresh terminal, you need to navigate to repo directory and: + - `source venv/bin/activate` + - `python3 zeronet.py` ## Current limitations