From d0846c8a5a5ab7a66eeb79c2caee5bf87a98c4be Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 16 Nov 2022 11:17:51 +0100
Subject: Adding unitary tests.

---
 README.md | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ec27a80..2b9c0b7 100644
--- a/README.md
+++ b/README.md
@@ -20,13 +20,13 @@ Consider that all inline commands below needs to be executed into ArGaze root fo
 pip install build
 ```
 
-- Then, build argaze package: 
+- Then, build ArGaze package: 
 
 ```
 python -m build
 ```
 
-- Then, install argaze package (replace VERSION by what has been built into dist folder):
+- Then, install ArGaze package (replace VERSION by what has been built into dist folder):
 
 ```
 pip install ./dist/argaze-VERSION.whl
@@ -71,4 +71,24 @@ pdoc -o ./doc ./src/argaze/
 
    ```
    pdoc ./src/argaze/
-   ```
\ No newline at end of file
+   ```
+
+## Test
+
+ArGaze package unitary tests are based on *unittest* module.
+Test files tree structure is mirroring the file tree structure of src/argaze folder.
+
+To run all unitary tests:
+
+```
+python -m unittest discover ./src/argaze.test "*.py"
+```
+
+To run only submodule unitary tests:
+
+```
+python -m unittest discover ./src/argaze.test/SUBMODULE "*.py"
+```
+
+.. note:: Verbose mode
+   *Use -v option to get more details.*
-- 
cgit v1.1