diff --git a/README.md b/README.md index c6ecf2f0f5d61b357bacad0163195b50eacf7305..2e5ba5b3fa2fe519b78024382d9d9e2195424f36 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ pip install binarycpython This will install the latest stable installation that is available on Pip. The version on the master branch should be the same version as the latest stable version on Pip ### Installation from source: -We can also install the package from source, which is useful for development versions and when you want to modify the code. It is recommended that you install this into a virtual environment. From within the root directory, run +We can also install the package from source, which is useful for development versions and when you want to modify the code. It is recommended that you install this into a virtual environment. From within the `commands/` directory, run ``` ./install.sh ``` @@ -80,6 +80,20 @@ pip install -r development_requirements.txt Please do not hesitate to contact us to discuss any developments. +### Building documentation +To build the documentation manually, run +``` +./generate_docs.sh +``` +from within the `commands/` directory + +### Running unit tests +To generate the unit test and docstring coverage report, run +``` +./generate_reports.sh +``` +from within the `commands/` directory + ## FAQ/Issues: Here we provide a non-exhaustive list of some issues we encountered and solutions for these: