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/getting_started | |
| 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/getting_started')
| -rw-r--r-- | docs/getting_started/demos.md | 8 | ||||
| -rw-r--r-- | docs/getting_started/installation.md | 31 | ||||
| -rw-r--r-- | docs/getting_started/ready-made.md | 8 |
3 files changed, 0 insertions, 47 deletions
diff --git a/docs/getting_started/demos.md b/docs/getting_started/demos.md deleted file mode 100644 index 1a53c82..0000000 --- a/docs/getting_started/demos.md +++ /dev/null @@ -1,8 +0,0 @@ -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 deleted file mode 100644 index 327e79a..0000000 --- a/docs/getting_started/installation.md +++ /dev/null @@ -1,31 +0,0 @@ -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 deleted file mode 100644 index 32c475c..0000000 --- a/docs/getting_started/ready-made.md +++ /dev/null @@ -1,8 +0,0 @@ -Ready-made scripts -================== - -{% - include-markdown "../../src/argaze/utils/README.md" - start="<!--ready-start-->" - end="<!--ready-end-->" -%} |