From 078871a7274c9b3348541e6b4fbfffaf67d33842 Mon Sep 17 00:00:00 2001
From: Moul <moul@moul.re>
Date: Fri, 10 Dec 2021 17:48:08 +0100
Subject: [PATCH] [doc] #165: Readme: Update make commands accordingly

---
 README.md | 18 ++++++++----------
 1 file changed, 8 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index aa71f20b..fd9f546f 100644
--- a/README.md
+++ b/README.md
@@ -83,16 +83,14 @@ poetry run python
 poetry install
 ```
 
-- Generate documentation
+- Generate HTML documentation in `public` directory:
 ```bash
-poetry run make docs
+make docs
 ```
 
-- The HTML documentation is generated in `docs/_build/html` folder.
-
 ## Development
 * When writing docstrings, use the reStructuredText format recommended by https://www.python.org/dev/peps/pep-0287/#docstring-significant-features
-* Use `make` commands to check the code and the format.
+* Use `make check` commands to check the code and the format.
 
 * Install runtime dependencies
 ```bash
@@ -108,7 +106,7 @@ poetry install
 
 * Check static typing with [mypy](http://mypy-lang.org/)
 ```bash
-make check
+make mypy
 ```
 
 ## Packaging and deploy
@@ -123,9 +121,9 @@ Build the PyPI package in the `dist` folder
 make build
 ```
 
-Deploy the package to PyPI test repository (prefix the command with a space for the shell to not save it in its history system, since the command contains credentials)
+Deploy the package to PyPI test repository:
 ```bash
-[SPACE]make deploy_test PYPI_TEST_LOGIN=xxxx PYPI_TEST_PASSWORD=xxxx
+make deploy_test
 ```
 
 Install the package from PyPI test repository
@@ -133,9 +131,9 @@ Install the package from PyPI test repository
 pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.python.org/simple/ duniterpy
 ```
 
-Deploy the package on the PyPI repository (prefix the command with a space for the shell to not save it in its history system, since the command contains credentials)
+Deploy the package on the PyPI repository:
 ```bash
-[SPACE]make deploy PYPI_LOGIN=xxxx PYPI_PASSWORD=xxxx
+make deploy
 ```
 
 ## Packaging status
-- 
GitLab