Include explanation for virtual environments and package extras in README
Marco Ricci

Marco Ricci commited on 2024-09-12 21:26:03
Zeige 1 geänderte Dateien mit 10 Einfügungen und 0 Löschungen.

... ...
@@ -18,10 +18,20 @@ The service name and constraints themselves also need not be kept secret; the la
18 18
 
19 19
 ### With `pip`
20 20
 
21
+(If not inside a [virtual environment][VENV], use `pip install --user` instead of plain `pip install`.)
22
+
21 23
 ```` shell-session
22 24
 $ pip install derivepassphrase
23 25
 ````
24 26
 
27
+To use the `export` subcommand, install the `export` extra:
28
+
29
+```` shell-session
30
+$ pip install "derivepassphrase[export]"
31
+````
32
+
33
+[VENV]: https://docs.python.org/3/library/venv.html
34
+
25 35
 ### Manually
26 36
 
27 37
 `derivepassphrase` is a pure Python package, and may be easily installed manually by placing the respective files and the package's dependencies into Python's import path.
28 38