derivepassphrase.git

Fix installation instructions in basic setup (passphrase) tutorial
Parent 9a57ada
Marco Ricci

Marco Ricci commited on 2024-10-21 13:23:20
Zeige 1 geänderte Dateien mit 13 Einfügungen und 6 Löschungen. 

The previous installation instructions just blindly assumed `pipx` were
available.  Assuming that only `pip` is available is better (because
a standard Python installation contains everything necessary to
bootstrap `pip`), and providing short, toggleable installation
instructions for common Python package managers is even better.  We now
do the latter.
docs/tutorials/basic-setup-password.md
Zeige Datei @ db91cd7
... ... 
@@ -40,21 +40,28 @@ We will assume the following three services with the following passphrase polici
40 40
41 41 
 ## Installing `derivepassphrase`
42 42
43 
-Install `pipx`:
43 
+You will need Python 3.9 or later, and a package installer such as `pip` (bundled with Python), `pipx` or similar.
44 
+
45 
+---
46 
+
47 
+=== "pip"
48 
+
49 
+    With `pip`, using a "virtual enviroment" at `~/.venv` to avoid clobbering our system configuration:
44 50
45 51 
     ~~~~ shell-session
46 
-$ cd ~
47 
-$ python3 -m venv .venv
48 
-$ . .venv/bin/activate
49 
-$ pip install pipx
52 
+    $ python3 -m venv ~/.venv
53 
+    $ . ~/.venv/bin/activate
54 
+    $ pip install derivepassphrase
50 55 
     ~~~~
51 56
52 
-Install `derivepassphrase`:
57 
+=== "pipx"
53 58
54 59 
     ~~~~ shell-session
55 60 
     $ pipx install derivepassphrase
56 61 
     ~~~~
57 62
63 
+---
64 
+
58 65 
 Check that the installation was successful.
59 66
60 67 
 ~~~~ shell-session
61 68