Skip to content
Snippets Groups Projects
Commit 76708f2e authored by dh00601's avatar dh00601
Browse files

updated readme

parent 16f2f0f9
No related branches found
No related tags found
No related merge requests found
...@@ -45,7 +45,7 @@ pip install binarycpython ...@@ -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 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: ### 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 ./install.sh
``` ```
...@@ -80,6 +80,20 @@ pip install -r development_requirements.txt ...@@ -80,6 +80,20 @@ pip install -r development_requirements.txt
Please do not hesitate to contact us to discuss any developments. 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: ## FAQ/Issues:
Here we provide a non-exhaustive list of some issues we encountered and solutions for these: 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