From 76708f2e9c23ea7c994d8d16974d6b8128c3ea24 Mon Sep 17 00:00:00 2001
From: dh00601 <dh00601@surrey.ac.uk>
Date: Fri, 3 Jun 2022 14:50:16 +0100
Subject: [PATCH] updated readme

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c6ecf2f0f..2e5ba5b3f 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: 
 
-- 
GitLab