|
7 | 7 |
|
8 | 8 | Generated from [the Pimoroni Python Boilerplate](https://github.com/pimoroni/boilerplate-python).
|
9 | 9 |
|
10 |
| -# Pre-requisites |
| 10 | +product description goes here |
11 | 11 |
|
12 |
| -You must enable (delete where appropriate): |
| 12 | +## Where to buy |
13 | 13 |
|
14 |
| -* i2c: `sudo raspi-config nonint do_i2c 0` |
15 |
| -* spi: `sudo raspi-config nonint do_spi 0` |
16 |
| - |
17 |
| -You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configuration UI to enable interfaces. |
| 14 | +* [link goes here](link goes here) |
18 | 15 |
|
19 | 16 | # Installing
|
20 | 17 |
|
21 |
| -Stable library from PyPi: |
| 18 | +We'd recommend using this library with Raspberry Pi OS Bookworm or later. It requires Python ≥3.7. |
| 19 | + |
| 20 | +## Full install (recommended): |
| 21 | + |
| 22 | +We've created an easy installation script that will install all pre-requisites and get you up and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal |
| 23 | +on your Raspberry Pi desktop, as illustrated below: |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +In the new terminal window type the commands exactly as it appears below (check for typos) and follow the on-screen instructions: |
| 28 | + |
| 29 | +```bash |
| 30 | +git clone https://github.com/pimoroni/PROJECT_NAME-python |
| 31 | +cd PROJECT_NAME-python |
| 32 | +./install.sh |
| 33 | +``` |
| 34 | + |
| 35 | +**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples: |
22 | 36 |
|
23 |
| -* Just run `pip3 install PROJECT_NAME` |
| 37 | +``` |
| 38 | +source ~/.virtualenvs/pimoroni/bin/activate |
| 39 | +``` |
24 | 40 |
|
25 |
| -In some cases you may need to use `sudo` or install pip with: `sudo apt install python3-pip` |
| 41 | +## Development: |
26 | 42 |
|
27 |
| -Latest/development library from GitHub: |
| 43 | +If you want to contribute, or like living on the edge of your seat by having the latest code, you can install the development version like so: |
| 44 | + |
| 45 | +```bash |
| 46 | +git clone https://github.com/pimoroni/PROJECT_NAME-python |
| 47 | +cd PROJECT_NAME-python |
| 48 | +./install.sh --unstable |
| 49 | +``` |
| 50 | + |
| 51 | +## Install stable library from PyPi and configure manually |
| 52 | + |
| 53 | +* Set up a virtual environment: `python3 -m venv --system-site-packages $HOME/.virtualenvs/pimoroni` |
| 54 | +* Switch to the virtual environment: `source ~/.virtualenvs/pimoroni/bin/activate` |
| 55 | +* Install the library: `pip install PROJECT_NAME` |
| 56 | + |
| 57 | +In some cases you may need to us `sudo` or install pip with: `sudo apt install python3-pip`. |
| 58 | + |
| 59 | +This will not make any configuration changes, so you may also need to enable: |
| 60 | + |
| 61 | +* i2c: `sudo raspi-config nonint do_i2c 0` |
| 62 | +* spi: `sudo raspi-config nonint do_spi 0` |
| 63 | + |
| 64 | +You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configuration UI to enable interfaces. |
28 | 65 |
|
29 |
| -* `git clone https://github.com/pimoroni/PROJECT_NAME-python` |
30 |
| -* `cd PROJECT_NAME-python` |
31 |
| -* `./install.sh --unstable` |
| 66 | +Some of the examples have additional dependencies. You can install them with: |
32 | 67 |
|
| 68 | +```bash |
| 69 | +pip install |
| 70 | +``` |
0 commit comments