From 6f84107702528bb9599cf31e92eaa092f9ab3a26 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Wed, 30 Mar 2022 16:22:07 +0200 Subject: Updating Argaze installation steps --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) (limited to 'README.md') 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/ -- cgit v1.1