From 83065c95479dbe00e61714aa0a4a6f2e5a2af397 Mon Sep 17 00:00:00 2001 From: David Banas Date: Wed, 12 Jan 2022 14:03:29 -0800 Subject: [PATCH 1/2] Update README.md --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9530f0c..52c124e 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,16 @@ 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 +## 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 +25,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 From cac9c2357752f88e709c230a694399f6dcf64fac Mon Sep 17 00:00:00 2001 From: David Banas Date: Wed, 12 Jan 2022 14:05:53 -0800 Subject: [PATCH 2/2] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 52c124e..c5f6c3e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,14 @@ 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. +## Wiki + +- https://github.com/capn-freako/PyBERT/wiki + +## FAQ + +- https://github.com/capn-freako/PyBERT/wiki/pybert_faq + ## User Installation -