diff --git a/README.md b/README.md index 2e5ba5b3fa2fe519b78024382d9d9e2195424f36..92ca8778ce92e5c61305c5bb0f20fc28ed81bc39 100644 --- a/README.md +++ b/README.md @@ -80,20 +80,23 @@ pip install -r development_requirements.txt Please do not hesitate to contact us to discuss any developments. -### Building documentation +### Generating documentation To build the documentation manually, run ``` ./generate_docs.sh ``` from within the `commands/` directory -### Running unit tests +### Generating docstring and test coverage report To generate the unit test and docstring coverage report, run ``` ./generate_reports.sh ``` from within the `commands/` directory +### Running unit tests +There are two versions of the unit tests. The first includes only the actual code of the project, and is located at `binarycpython/test/main.py`. The second includes the tutorial notebooks, and is located at `binarycpython/test/main_with_notebooks.py` + ## FAQ/Issues: Here we provide a non-exhaustive list of some issues we encountered and solutions for these: