aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThéo de la Hogue2022-03-14 23:55:06 +0100
committerThéo de la Hogue2022-03-14 23:55:06 +0100
commit39b2f50bd0e39c006f572e3677a4636a13643ce4 (patch)
treee8bfae2a527aef6fbd954dab46c6143cfc9a25a8
parent7d01f4880975d07c034415ebdac169e6ad52e6b5 (diff)
downloadargaze-39b2f50bd0e39c006f572e3677a4636a13643ce4.zip
argaze-39b2f50bd0e39c006f572e3677a4636a13643ce4.tar.gz
argaze-39b2f50bd0e39c006f572e3677a4636a13643ce4.tar.bz2
argaze-39b2f50bd0e39c006f572e3677a4636a13643ce4.tar.xz
Fixing README syntax
-rw-r--r--README.md4
-rw-r--r--src/argaze/RegionOfInterest/README.md4
-rw-r--r--src/argaze/TobiiGlassesPro2/README.md2
3 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index c4f1292..1897642 100644
--- a/README.md
+++ b/README.md
@@ -7,13 +7,13 @@ _An open-source python toolkit to deal with gaze tracking and analysis in Augmen
In the ArGaze root folder:
'''
- python -m build
+python -m build
'''
Then,
'''
- pip install dist/argaze<VERSION>.whl
+pip install dist/argaze<VERSION>.whl
'''
(Replace <VERSION> by what will be built into dist folder)
diff --git a/src/argaze/RegionOfInterest/README.md b/src/argaze/RegionOfInterest/README.md
index faeb714..9c113b2 100644
--- a/src/argaze/RegionOfInterest/README.md
+++ b/src/argaze/RegionOfInterest/README.md
@@ -1,7 +1,7 @@
# RegionOfInterest
-_Class interface to manage ROIs_
-https://en.wikipedia.org/wiki/Region_of_interest#:~:text=A%20region%20of%20interest%20(often,purpose%20of%20measuring%20its%20size.
+_Class interface to manage [ROIs](https://en.wikipedia.org/wiki/Region_of_interest#:~:text=A%20region%20of%20interest%20(often,purpose%20of%20measuring%20its%20size)_
+
## ROI2DScene.py
diff --git a/src/argaze/TobiiGlassesPro2/README.md b/src/argaze/TobiiGlassesPro2/README.md
index 3352274..5c9b288 100644
--- a/src/argaze/TobiiGlassesPro2/README.md
+++ b/src/argaze/TobiiGlassesPro2/README.md
@@ -1,7 +1,7 @@
# TobiiGlassesPro2
_This module provides a class interface to handle TobbiGlassesPro2 data and video stream.
-It is based on TobiiGlassesPyController package (https://github.com/ddetommaso/TobiiGlassesPyController)._
+It is based on [TobiiGlassesPyController package](https://github.com/ddetommaso/TobiiGlassesPyController)._
## To connect Tobii glasses on Mac OS