Skip to content
Snippets Groups Projects
Commit 0f018c55 authored by dh00601's avatar dh00601
Browse files

updated readme

parent 8d3b7bbe
No related branches found
No related tags found
No related merge requests found
......@@ -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:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment