From 6a49538213c985dbd3ce9526ee85c5bcba376278 Mon Sep 17 00:00:00 2001 From: webreflection Date: Mon, 22 Apr 2024 09:59:45 +0200 Subject: [PATCH] Improved the contribution "getting started" --- .gitignore | 6 +++++- README.md | 9 ++++++++- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 9b6079a..bf99dd2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ _env site -.DS_Store \ No newline at end of file +.DS_Store +bin +lib +lib64 +pyvenv.cfg diff --git a/README.md b/README.md index 36a7da7..8af4f1b 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,16 @@ To setup the documentation development environment simply create a new virtual environment, then `pip install -r requirements.txt` (from in the root of this repository). +```sh +# example of a simple virtual environment +# creation from the root of this project +python -m venv . +./bin/pip install -r requirements.txt +``` + ## Build -Simply run `mkdocs serve` +Simply run `mkdocs serve` or `./bin/mkdocs serve`. ## Cross-referencing