From c4552e04e1271a9210a934233beae5be1943d034 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Wed, 7 Jun 2023 14:34:14 +0200 Subject: Writing User guide and use cases section. --- docs/getting_started/demos.md | 8 -------- docs/getting_started/installation.md | 31 ------------------------------- docs/getting_started/ready-made.md | 8 -------- 3 files changed, 47 deletions(-) delete mode 100644 docs/getting_started/demos.md delete mode 100644 docs/getting_started/installation.md delete mode 100644 docs/getting_started/ready-made.md (limited to 'docs/getting_started') 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="" - 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="" - end="" -%} -- cgit v1.1