aboutsummaryrefslogtreecommitdiff
path: root/docs/getting_started
diff options
context:
space:
mode:
Diffstat (limited to 'docs/getting_started')
-rw-r--r--docs/getting_started/demos.md8
-rw-r--r--docs/getting_started/installation.md31
-rw-r--r--docs/getting_started/ready-made.md8
3 files changed, 47 insertions, 0 deletions
diff --git a/docs/getting_started/demos.md b/docs/getting_started/demos.md
new file mode 100644
index 0000000..1a53c82
--- /dev/null
+++ b/docs/getting_started/demos.md
@@ -0,0 +1,8 @@
+Demonstration scripts
+=====================
+
+{%
+ include-markdown "../../src/argaze/utils/README.md"
+ start="<!--demo-start-->"
+ end="<!--demo-end-->"
+%}
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 .
+ ```
diff --git a/docs/getting_started/ready-made.md b/docs/getting_started/ready-made.md
new file mode 100644
index 0000000..32c475c
--- /dev/null
+++ b/docs/getting_started/ready-made.md
@@ -0,0 +1,8 @@
+Ready-made scripts
+==================
+
+{%
+ include-markdown "../../src/argaze/utils/README.md"
+ start="<!--ready-start-->"
+ end="<!--ready-end-->"
+%}