diff options
author | Théo de la Hogue | 2023-06-07 14:34:14 +0200 |
---|---|---|
committer | Théo de la Hogue | 2023-06-07 14:34:14 +0200 |
commit | c4552e04e1271a9210a934233beae5be1943d034 (patch) | |
tree | a44041e544bc700976237bfea9058ec06f9a2904 /docs/installation.md | |
parent | bd9cd27c9d44c072164f564ffffeb22e37106b89 (diff) | |
download | argaze-c4552e04e1271a9210a934233beae5be1943d034.zip argaze-c4552e04e1271a9210a934233beae5be1943d034.tar.gz argaze-c4552e04e1271a9210a934233beae5be1943d034.tar.bz2 argaze-c4552e04e1271a9210a934233beae5be1943d034.tar.xz |
Writing User guide and use cases section.
Diffstat (limited to 'docs/installation.md')
-rw-r--r-- | docs/installation.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..4b84a19 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,45 @@ +--- +title: Package installation +--- + +How to install ArGaze +===================== + +!!! warning + + *ArGaze is not yet in public repository: [contact ACHIL laboratory](mailto:achil-contact@recherche.enac.fr) to get in touch.* + +Clone ArGaze repository: + +```console +git clone ssh://git@git.recherche.enac.fr/interne-ihm-aero/eye-tracking/argaze.git +``` + +!!! note + + *Consider that all inline commands below have to be executed at the root of ArGaze package folder.* + +Install build tool package: + +```console +pip install build +``` + +Then, build ArGaze package: +```console +python -m build +``` + +Then, install ArGaze package (replace VERSION by what has been built into dist folder): +```console +pip install ./dist/argaze-VERSION.whl +``` + +!!! note + + **As Argaze library contributor** + *You should prefer to install the package in developer mode to test live code changes:* + + ``` + pip install -e . + ``` |