Skip to content

Commit

Permalink
Merge branch 'master' of github.com:capn-freako/PyBERT
Browse files Browse the repository at this point in the history
  • Loading branch information
David Banas committed Feb 10, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
2 parents 7288d69 + cac9c23 commit a72f2fb
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

- <https://github.com/capn-freako/PyBERT/wiki/instant_gratification>

## Developer Installation

- <https://github.com/capn-freako/PyBERT/wiki/dev_install>

## 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 <https://github.com/capn-freako/PyBERT/wiki/instant_gratification>

0 comments on commit a72f2fb

Please sign in to comment.