diff --git a/README.md b/README.md index 9530f0c..c5f6c3e 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,24 @@ as well as the NumPy and SciPy packages. Notice: Before using this package for any purpose, you MUST read and understand the terms put forward in the accompanying "LICENSE" file. -## Installation +## Wiki + +- https://github.com/capn-freako/PyBERT/wiki + +## FAQ + +- https://github.com/capn-freako/PyBERT/wiki/pybert_faq + +## User Installation + - +## Developer Installation + +- + ## Testing + Tox is used for the test runner and documentation builder. By default, it runs the following environments: _py36_, _py37_, _pylint_, _flake8_ and _docs_. It will skip any missing python versions. * `pip install tox` @@ -19,11 +33,14 @@ environments: _py36_, _py37_, _pylint_, _flake8_ and _docs_. It will skip any m To run a single environment such as "docs" run: `tox -e docs` ## Documentation + PyBERT documentation exists in 2 separate forms: - For developers: + - pybert/doc/build/html/index.html (See testing on how to build the documentation) - + - https://github.com/capn-freako/PyBERT/wiki/dev_install + - For users: - Quick installation instructions at