aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThéo de la Hogue2022-03-30 16:22:07 +0200
committerThéo de la Hogue2022-03-30 16:22:07 +0200
commit6f84107702528bb9599cf31e92eaa092f9ab3a26 (patch)
tree0237197fee3358b63f02f92c37b78fc4d969ce2a /README.md
parent9343cf9917983b9617d948b96b1a6ced24a6dab8 (diff)
downloadargaze-6f84107702528bb9599cf31e92eaa092f9ab3a26.zip
argaze-6f84107702528bb9599cf31e92eaa092f9ab3a26.tar.gz
argaze-6f84107702528bb9599cf31e92eaa092f9ab3a26.tar.bz2
argaze-6f84107702528bb9599cf31e92eaa092f9ab3a26.tar.xz
Updating Argaze installation steps
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index 8a66f09..f4d7ff0 100644
--- a/README.md
+++ b/README.md
@@ -14,19 +14,25 @@ The ArGaze toolkit is divided in submodules dedicated to various purposes:
Consider that all inline commands below needs to be executed into ArGaze root folder.
-- Build package:
+- Install build tool package:
+
+```
+pip install build
+```
+
+- Then, build argaze package:
```
python -m build
```
-- Then, install package (replace VERSION by what has been built into dist folder):
+- Then, install argaze package (replace VERSION by what has been built into dist folder):
```
pip install ./dist/argaze-VERSION.whl
```
-As Argaze library developper, you should prefer to install the package in developer mode to test live code changes:
+*As Argaze library developper, you should prefer to install the package in developer mode to test live code changes:*
```
pip install -e .
@@ -48,7 +54,7 @@ pip install pdoc
pdoc -o ./doc ./src/argaze/
```
-As Argaze library developper, you should prefer to create a local html server to watch live documentation changes:
+*As Argaze library developper, you should prefer to create a local html server to watch live documentation changes:*
```
pdoc ./src/argaze/