From f072882b23ca7f53a495bec8d2267451e86320da Mon Sep 17 00:00:00 2001 From: Nick Telfer Date: Thu, 27 Sep 2018 16:21:55 -0600 Subject: [PATCH] updated documentation --- docs/building_releases.md | 7 ++++++- docs/getting_started/getting_started.md | 9 ++++++++- docs/getting_started/getting_started.rst | 7 ++++++- readme.md | 14 ++++++++++++-- 4 files changed, 32 insertions(+), 5 deletions(-) diff --git a/docs/building_releases.md b/docs/building_releases.md index 24f53c7..dffe41b 100644 --- a/docs/building_releases.md +++ b/docs/building_releases.md @@ -2,14 +2,19 @@ Use Semantic versioning as described [here](https://semver.org/) when releasing any new code. # Building Wheels -Make sure you have installed the packaging dependencies with pip +Make sure you have installed the packaging dependencies ```bash pip install wheel pip install twine +sudo apt install npm ``` Then run these commands ```bash +cd /path/to/didery/src/didery/static/ +npm install +npm run-script transcrypt + cd path/to/didery/ python3 setup.py sdist bdist_wheel ``` diff --git a/docs/getting_started/getting_started.md b/docs/getting_started/getting_started.md index c83e1c8..8db10a8 100644 --- a/docs/getting_started/getting_started.md +++ b/docs/getting_started/getting_started.md @@ -1,3 +1,10 @@ +System Requirements +=================== +python 3.6 +libsodium 1.0.16 +Linux or macOS + + Installation ============ @@ -23,7 +30,7 @@ $ npm install $ npm run-script transcrypt ``` -A common issue with running the software is that your system doesn't have libsodium 13 or greater installed. Run these commands and try again: +A common issue with running the software is that your system doesn't have libsodium 16 or greater installed. Run these commands and try again: Mac ``` diff --git a/docs/getting_started/getting_started.rst b/docs/getting_started/getting_started.rst index 0f21d42..1372ee2 100644 --- a/docs/getting_started/getting_started.rst +++ b/docs/getting_started/getting_started.rst @@ -1,3 +1,8 @@ +System Requirements +=================== + +python 3.6 libsodium 1.0.16 Linux or macOS + Installation ============ @@ -36,7 +41,7 @@ Then run these commands: $ npm run-script transcrypt A common issue with running the software is that your system doesn't -have libsodium 13 or greater installed. Run these commands and try +have libsodium 16 or greater installed. Run these commands and try again: Mac diff --git a/readme.md b/readme.md index 6b42ffc..4a53360 100644 --- a/readme.md +++ b/readme.md @@ -10,7 +10,17 @@ Cryptographic key management is a challenging problem for the blockchain communi The project is built on the open source [ioflo](https://github.com/ioflo) framework and also utilizes [click](http://click.pocoo.org/5/), and [lmdb](https://lmdb.readthedocs.io/en/release/) on the back end. The frontend is built with [Transcrypt](https://www.transcrypt.org/documentation) and [mithril.js](https://mithril.js.org/). - +System Requirements +=================== +python 3.6 +libsodium 1.0.16 +Linux or macOS + +Development Dependencies +======================== +git +npm +wheel Installation ============ @@ -37,7 +47,7 @@ $ npm install $ npm run-script transcrypt ``` -A common issue with running the software is that your system doesn't have libsodium 13 or greater installed. Run these commands and try again: +A common issue with running the software is that your system doesn't have libsodium 16 or greater installed. Run these commands and try again: Mac ```