Commit 14f8e6746da4b5f4687cc2562a117900f28870a5
1 parent
6a603afc
Exists in
dev
(doc) update README.md
Showing
1 changed file
with
8 additions
and
23 deletions
Show diff stats
README.md
| 1 | # Getting Started | 1 | # Getting Started |
| 2 | 2 | ||
| 3 | -Latest review: 2022-04-04 | 3 | +Latest review: 2023-04-05 |
| 4 | 4 | ||
| 5 | ## Installation | 5 | ## Installation |
| 6 | 6 | ||
| @@ -19,40 +19,25 @@ To use the software we need to: | @@ -19,40 +19,25 @@ To use the software we need to: | ||
| 19 | 19 | ||
| 20 | Each of these steps is explained below. | 20 | Each of these steps is explained below. |
| 21 | 21 | ||
| 22 | -### Install python3 with sqlite3 support | 22 | +### Install python with sqlite3 and pip support |
| 23 | 23 | ||
| 24 | Minimum supported version is python3.9. The installed versions depend on the | 24 | Minimum supported version is python3.9. The installed versions depend on the |
| 25 | operating system default. | 25 | operating system default. |
| 26 | 26 | ||
| 27 | ```sh | 27 | ```sh |
| 28 | -sudo pkg install python3 py39-sqlite3 # FreeBSD | ||
| 29 | -sudo apt install python3 # Linux (Ubuntu) | ||
| 30 | -sudo port install python311 # MacOS | ||
| 31 | -``` | ||
| 32 | - | ||
| 33 | -### Install pip | ||
| 34 | - | ||
| 35 | -Install `pip` from the system package manager: | ||
| 36 | - | ||
| 37 | -```sh | ||
| 38 | -sudo pkg install py39-pip # FreeBSD | ||
| 39 | -sudo apt install python3-pip # Linux (Ubuntu) | ||
| 40 | -sudo port install py311-pip # MacOS | 28 | +sudo pkg install python3 py39-sqlite3 py39-pip # FreeBSD |
| 29 | +sudo apt install python3 python3-pip # Linux (Ubuntu) | ||
| 30 | +sudo port install python311 py311-pip # MacOS | ||
| 41 | ``` | 31 | ``` |
| 42 | 32 | ||
| 43 | In the end you should be able to run `python3 -m pip --version` and `python3 -c | 33 | In the end you should be able to run `python3 -m pip --version` and `python3 -c |
| 44 | "import sqlite3"` without errors. | 34 | "import sqlite3"` without errors. |
| 45 | 35 | ||
| 46 | Packages should **not** be installed system-wide. Either install them to a | 36 | Packages should **not** be installed system-wide. Either install them to a |
| 47 | -python virtual environment or in the user area. | ||
| 48 | - | ||
| 49 | -To install in the user area use `python3 -m pip install --user some_package` or | ||
| 50 | -edit the configuration file `~/.config/pip/pip.conf` (FreeBSD, Linux) or | ||
| 51 | -`~/Library/Application Support/pip/pip.conf` (MacOS) and add the lines | 37 | +python virtual environment or in the user area. To install in the user area use |
| 52 | 38 | ||
| 53 | -```ini | ||
| 54 | -[global] | ||
| 55 | -user = yes | 39 | +```sh |
| 40 | +python3 -m pip install --user some_package | ||
| 56 | ``` | 41 | ``` |
| 57 | 42 | ||
| 58 | ### Install aprendizations | 43 | ### Install aprendizations |