From b46433c90764800d44299a229569d6d5b49ee1fb Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Tue, 15 Mar 2022 17:55:07 +0100
Subject: Adding utils submodule. Writing documention.

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 36 insertions(+), 14 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index eee7721..902f796 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,54 @@
-# ArGaze library
+An open-source python toolkit to deal with gaze tracking and analysis in Augmented Reality (AR) environnement.
 
-_An open-source python toolkit to deal with gaze tracking and analysis in Augmented Reality (AR) environnement._
+## Architecture
+
+The ArGaze toolkit is divided in submodules dedicated to various purposes:
+
+* ArUcoMarkers: ArUco markers generator, traking, camera calibration, ...
+* RegionOfInterest: Region Of Interest (ROI) scene management for 2D and 3D environment.
+* TobiiGlassesPro2: A gaze tracking device interface.
+* utils: Collection of ready-to-use high level feature scripts based on ArGaze toolkit.
 
 ## Installation
 
-In the ArGaze root folder: 
+Consider that all inline commands below needs to be executed into ArGaze root folder.
+
+- Build package: 
 
 ```
 python -m build
 ```
 
-Then, 
+- Then, install package (replace VERSION by what has been built into dist folder):
 
 ```
-pip install dist/argaze-VERSION.whl
+pip install ./dist/argaze-VERSION.whl
 ```
 
-(Replace VERSION by what will be built into dist folder)
+As Argaze library developper, you should prefer to install the package in developer mode to test live code changes:
 
-## Architecture
+```
+pip install -e .
+```
 
-The ArGaze toolkit is divided in submodules dedicated to various purposes:
+## Documentation
 
-* ArUcoMarkers: ArUco markers generator, traking, camera calibration, ...
-* RegionOfInterest: Region Of Interest (ROI) scene management for 2D and 3D environment.
-* TobiiGlassesPro2: a gaze tracking device interface.
-* _..._
+To generate html documentation using [pdoc](https://pdoc.dev/), 
+
+- Install 'pdoc' package:
+
+```
+pip install pdoc
+```
 
-## Examples
+- Then, build documentation into doc folder:
 
-The ArGaze toolkit provides a set of python scripts to undertand how the submodules can be used together.
+```
+pdoc -o ./doc ./src/argaze/ 
+```
+
+As Argaze library developper, you should prefer to create a local html server to watch live documentation changes:
+
+```
+pdoc ./src/argaze/
+```
\ No newline at end of file
-- 
cgit v1.1