aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c4f1292
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# ArGaze library
+
+_An open-source python toolkit to deal with gaze tracking and analysis in Augmented Reality (AR) environnement._
+
+## Installation
+
+In the ArGaze root folder:
+
+'''
+ python -m build
+'''
+
+Then,
+
+'''
+ pip install dist/argaze<VERSION>.whl
+'''
+
+(Replace <VERSION> by what will be built into dist folder)
+
+## 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.
+* _..._
+
+## Examples
+
+The ArGaze toolkit provides a set of python scripts to undertand how the submodules can be used together.