diff options
| author | Théo de la Hogue | 2022-11-09 13:45:49 +0100 |
|---|---|---|
| committer | Théo de la Hogue | 2022-11-09 13:45:49 +0100 |
| commit | d56194d29c792a375abf306f22254e2ab51f11f6 (patch) | |
| tree | 61cc6784db2230cee05cfb49de9d91e07d4dc116 /README.md | |
| parent | a2701988bb9eea04ee83de20b7e71caccbe5b5af (diff) | |
| download | argaze-d56194d29c792a375abf306f22254e2ab51f11f6.zip argaze-d56194d29c792a375abf306f22254e2ab51f11f6.tar.gz argaze-d56194d29c792a375abf306f22254e2ab51f11f6.tar.bz2 argaze-d56194d29c792a375abf306f22254e2ab51f11f6.tar.xz | |
Large documentation improvement.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 16 insertions, 14 deletions
@@ -4,11 +4,11 @@ An open-source python toolkit to deal with dynamic Areas Of Interest (AOI) and g The ArGaze toolkit provides some generics data structures and algorithms to build AR environement with dynamic AOI and so allow gaze tracking with mobil eye tracker devices. It is divided in submodules dedicated to various specifics features: -* ArUcoMarkers: ArUco markers generator, traking, camera calibration, ... -* AreaOfInterest: Area Of Interest (AOI) scene management for 2D and 3D environment. -* TobiiGlassesPro2: A gaze tracking device interface. -* GazeFeatures: Generic gaze data structures definitions. -* utils: Collection of command-line high level features scripts based on ArGaze toolkit. +* `argaze.ArUcoMarkers`: ArUco markers generator, traking, camera calibration, ... +* `argaze.AreaOfInterest`: Area Of Interest (AOI) scene management for 2D and 3D environment. +* `argaze.GazeFeatures`: Generic gaze data structures definitions. +* `argaze.TobiiGlassesPro2`: A gaze tracking device interface. +* `argaze.utils`: Collection of command-line high level features scripts based on ArGaze toolkit. ## Installation @@ -32,11 +32,12 @@ python -m build pip install ./dist/argaze-VERSION.whl ``` -*As Argaze library developper, you should prefer to install the package in developer mode to test live code changes:* +.. note:: As Argaze library developper + *You should prefer to install the package in developer mode to test live code changes:* -``` -pip install -e . -``` + ``` + pip install -e . + ``` ## Documentation @@ -46,7 +47,7 @@ The [wiki](https://git.recherche.enac.fr/projects/argaze/wiki) provides many exp ### Cookbook -The **utils** submodule is a good place to get ready made code examples. +The `argaze.utils` submodule is a good place to get ready made code examples. ### Code @@ -65,8 +66,9 @@ pip install pdoc pdoc -o ./doc ./src/argaze/ ``` -*As Argaze library developper, you should prefer to create a local html server to watch live documentation changes:* +.. note:: 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 + ``` + pdoc ./src/argaze/ + ```
\ No newline at end of file |