aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThéo de la Hogue2022-11-16 20:15:09 +0100
committerThéo de la Hogue2022-11-16 20:15:09 +0100
commit02bd20b7cf914709e64980c1ce5faa9af2ad15f2 (patch)
treefd613ab7057946efebae3a8974a46a7f51c596db /README.md
parent33c8d6b7ed9f1ab2993da405430cca2910c5c636 (diff)
downloadargaze-02bd20b7cf914709e64980c1ce5faa9af2ad15f2.zip
argaze-02bd20b7cf914709e64980c1ce5faa9af2ad15f2.tar.gz
argaze-02bd20b7cf914709e64980c1ce5faa9af2ad15f2.tar.bz2
argaze-02bd20b7cf914709e64980c1ce5faa9af2ad15f2.tar.xz
Improving heading size.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index 2b9c0b7..cd6b147 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
An open-source python toolkit to deal with dynamic Areas Of Interest (AOI) and gaze tracking in Augmented Reality (AR) environnement.
-## Architecture
+# Architecture
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:
@@ -10,7 +10,7 @@ The ArGaze toolkit provides some generics data structures and algorithms to buil
* `argaze.TobiiGlassesPro2`: A gaze tracking device interface.
* `argaze.utils`: Collection of command-line high level features scripts based on ArGaze toolkit.
-## Installation
+# Installation
Consider that all inline commands below needs to be executed into ArGaze root folder.
@@ -39,17 +39,17 @@ pip install ./dist/argaze-VERSION.whl
pip install -e .
```
-## Documentation
+# Documentation
-### Wiki
+## Wiki
The [wiki](https://git.recherche.enac.fr/projects/argaze/wiki) provides many explanations about how works ArGaze, what is possible to do and code samples.
-### Cookbook
+## Cookbook
The `argaze.utils` submodule is a good place to get ready made code examples.
-### Code
+## Code
ArGaze code documentation is based on [pdoc](https://pdoc.dev/).
To generate html documentation:
@@ -73,9 +73,9 @@ pdoc -o ./doc ./src/argaze/
pdoc ./src/argaze/
```
-## Test
+# Test
-ArGaze package unitary tests are based on *unittest* module.
+ArGaze package unitary tests are based on [unittest](https://docs.python.org/fr/3.10/library/unittest.html) module.
Test files tree structure is mirroring the file tree structure of src/argaze folder.
To run all unitary tests: