diff options
Diffstat (limited to 'docs/getting_started/installation.md')
-rw-r--r-- | docs/getting_started/installation.md | 31 |
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 . + ``` |