Add example to how to install python libraries

Alban-Peyrat · Aug 30, 2024 · e8e9c2f · e8e9c2f
1 parent 38a3955
commit e8e9c2f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,10 @@ _Some previous changes will be added_
 
 ## [Unreleased]
 
+### Added
+
+* User documentation now has an example showing how to install a library in Python
+
 ## [2.0.0] - 2024-07-25
 
 ### Added

diff --git a/doc/user/EN/how_to_install.md b/doc/user/EN/how_to_install.md
@@ -6,7 +6,7 @@ Download the application and extract its content.
 
 Those libraries are used by the script but are not in the [Python Standard Library](https://docs.python.org/3/library/), all of them should be installed first :
 
-* _Reminder : with Windows, open the command terminal and write the following command lines after `py -m` (or `pyhton -m`)_
+* _Reminder : with Windows, open the command terminal and write the following command lines after `py -m` (or `pyhton -m`). For example, to install `pyisbn`, write `py -m pip install pyisbn==1.3.1`_
 * [`unidecode`](https://pypi.org/project/Unidecode/) (`pip install Unidecode==1.3.8`)
 * [`FuzzyWuzzy`](https://pypi.org/project/fuzzywuzzy/) (`pip install fuzzywuzzy==0.18.0`)
   * With [`python-Levenshtein`](https://pypi.org/project/python-Levenshtein/) (`pip install python-Levenshtein==0.25.1`), installed with `rapidfuzz` `3.9.3`

diff --git a/doc/user/FR/how_to_install.md b/doc/user/FR/how_to_install.md
@@ -6,7 +6,7 @@ Téléchargez l'application puis extrayez le contenu.
 
 Ces bibliothèques sont utilisées par le script mais absentes de la [Python Standard Library](https://docs.python.org/3/library/), il est donc nécessaire de les installer dans un premier temps :
 
-* _Rappel : sous Windows, ouvrir l'invite de commande, et taper les lignes de commandes suivantes après `py -m` (ou `pyhton -m`)_
+* _Rappel : sous Windows, ouvrir l'invite de commande, et taper les lignes de commandes suivantes après `py -m` (ou `pyhton -m`). Par exemple, pour installer `pyisbn`, taper `py -m pip install pyisbn==1.3.1`_
 * [`unidecode`](https://pypi.org/project/Unidecode/) (`pip install Unidecode==1.3.8`)
 * [`FuzzyWuzzy`](https://pypi.org/project/fuzzywuzzy/) (`pip install fuzzywuzzy==0.18.0`)
   * With [`python-Levenshtein`](https://pypi.org/project/python-Levenshtein/) (`pip install python-Levenshtein==0.25.1`), installé avec `rapidfuzz` `3.9.3`