work on docs, added firststeps.md

2019-06-28 15:23:03 -05:00 · 2019-06-28 15:23:03 -05:00 · bc8080765d
parent a27a5e5a45
commit bc8080765d
3 changed files with 20 additions and 0 deletions
--- a/docs/dev/http-api.md
+++ b/docs/dev/http-api.md
--- a/docs/usage/firststeps.md
+++ b/docs/usage/firststeps.md
@ -0,0 +1,7 @@
+# Onionr First Steps
+
+After installing Onionr, there are several things to do:
+
+1. Setup a [deterministic address](usage/deterministic.md) (optional)
+2. Add friends' ids
+3. Publish your id
--- a/docs/usage/install.md
+++ b/docs/usage/install.md
@ -0,0 +1,13 @@
+# Onionr Installation
+
+The following steps work broadly speaking for Windows, Mac, and Linux.
+
+1. Verify python3.6+ is installed: if its not see https://www.python.org/downloads/
+
+2. Verify Tor is installed (does not need to be running, binary can be put into system path or Onionr directory)
+
+3. [Optional but recommended]: setup virtual environment using [virtualenv](https://virtualenv.pypa.io/en/latest/), activate the virtual environment
+
+4. Clone Onionr: git clone https://gitlab.com/beardog/onionr
+
+5. Install the Python module dependencies: pip3 install --require-hashes -r requirements.txt