From 99a67dcd2dcb34c66be30e8f008f4c8576366c83 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 7 Jun 2023 20:57:17 +0200
Subject: Adding utils section and removing useless utils README.md file.

---
 docs/user_guide/utils/demonstrations_scripts.md | 41 +++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 docs/user_guide/utils/demonstrations_scripts.md

(limited to 'docs/user_guide/utils/demonstrations_scripts.md')

diff --git a/docs/user_guide/utils/demonstrations_scripts.md b/docs/user_guide/utils/demonstrations_scripts.md
new file mode 100644
index 0000000..5c4ef2b
--- /dev/null
+++ b/docs/user_guide/utils/demonstrations_scripts.md
@@ -0,0 +1,41 @@
+Demonstrations scripts
+======================
+
+Collection of command-line scripts for demonstration purpose.
+
+!!! note
+      *Consider that all inline commands below have to be executed at the root of ArGaze package folder.*
+
+!!! note
+      *Use -h option to get command arguments documentation.*
+
+## AR environment demonstration
+
+Load AR environment from **setup.json** file, detect ArUco markers into camera device (-d DEVICE) frames and estimate envirnoment pose.
+
+```shell
+python ./src/argaze/utils/demo_ar_features_run.py -d DEVICE
+```
+
+!!! warning
+      This demonstration assumes that camera calibration step is done and a **calibration.json** has been exported into *./src/argaze/utils/demo_environment/* folder.
+
+!!! note
+      Use **A3_demo.pdf** file located in *./src/argaze/utils/demo_environment/* folder ready to be printed on A3 paper sheet.
+
+## Gaze features demonstration
+
+Simulate gaze position using mouse pointer to illustrate gaze features.
+
+```shell
+python ./src/argaze/utils/demo_gaze_features_run.py
+```
+
+## Heatmap demonstration
+
+Simulate gaze position using mouse pointer to produce heatmap picture.
+A picture is saved by pressing escape key.
+
+```shell
+python ./src/argaze/utils/demo_heatmap_run.py
+```
-- 
cgit v1.1