aboutsummaryrefslogtreecommitdiff
path: root/docs/getting_started/installation.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-06-06 17:46:24 +0200
committerThéo de la Hogue2023-06-06 17:46:24 +0200
commitb109578ec1e8635aeb9f12c3a913108232347935 (patch)
tree27b309b6b5dfabc12b0d1c57cd43efc6ab6a35a3 /docs/getting_started/installation.md
parentfafa4b7e12147bab945a4b84ded53c6171d20427 (diff)
downloadargaze-b109578ec1e8635aeb9f12c3a913108232347935.zip
argaze-b109578ec1e8635aeb9f12c3a913108232347935.tar.gz
argaze-b109578ec1e8635aeb9f12c3a913108232347935.tar.bz2
argaze-b109578ec1e8635aeb9f12c3a913108232347935.tar.xz
Working on documentation architecture.
Diffstat (limited to 'docs/getting_started/installation.md')
-rw-r--r--docs/getting_started/installation.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/getting_started/installation.md b/docs/getting_started/installation.md
new file mode 100644
index 0000000..327e79a
--- /dev/null
+++ b/docs/getting_started/installation.md
@@ -0,0 +1,31 @@
+Install ArGaze
+==============
+
+!!! note
+
+ *Consider that all inline commands below have to be executed into ArGaze root 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 developper**
+ *You should prefer to install the package in developer mode to test live code changes:*
+
+ ```
+ pip install -e .
+ ```