Skip to content

Commit

Permalink
Merge pull request #17 from pimoroni/docs-tweak-readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Gadgetoid authored Aug 24, 2024
2 parents dbae8f3 + 038313b commit b936c5c
Showing 1 changed file with 51 additions and 13 deletions.
64 changes: 51 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,64 @@

Generated from [the Pimoroni Python Boilerplate](https://github.com/pimoroni/boilerplate-python).

# Pre-requisites
product description goes here

You must enable (delete where appropriate):
## Where to buy

* i2c: `sudo raspi-config nonint do_i2c 0`
* spi: `sudo raspi-config nonint do_spi 0`

You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configuration UI to enable interfaces.
* [link goes here](link goes here)

# Installing

Stable library from PyPi:
We'd recommend using this library with Raspberry Pi OS Bookworm or later. It requires Python ≥3.7.

## Full install (recommended):

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
on your Raspberry Pi desktop, as illustrated below:

![Finding the terminal](http://get.pimoroni.com/resources/github-repo-terminal.png)

In the new terminal window type the commands exactly as it appears below (check for typos) and follow the on-screen instructions:

```bash
git clone https://github.com/pimoroni/PROJECT_NAME-python
cd PROJECT_NAME-python
./install.sh
```

**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples:

* Just run `pip3 install PROJECT_NAME`
```
source ~/.virtualenvs/pimoroni/bin/activate
```

In some cases you may need to use `sudo` or install pip with: `sudo apt install python3-pip`
## Development:

Latest/development library from GitHub:
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:

```bash
git clone https://github.com/pimoroni/PROJECT_NAME-python
cd PROJECT_NAME-python
./install.sh --unstable
```

## Install stable library from PyPi and configure manually

* Set up a virtual environment: `python3 -m venv --system-site-packages $HOME/.virtualenvs/pimoroni`
* Switch to the virtual environment: `source ~/.virtualenvs/pimoroni/bin/activate`
* Install the library: `pip install PROJECT_NAME`

In some cases you may need to us `sudo` or install pip with: `sudo apt install python3-pip`.

This will not make any configuration changes, so you may also need to enable:

* i2c: `sudo raspi-config nonint do_i2c 0`
* spi: `sudo raspi-config nonint do_spi 0`

You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configuration UI to enable interfaces.

* `git clone https://github.com/pimoroni/PROJECT_NAME-python`
* `cd PROJECT_NAME-python`
* `./install.sh --unstable`
Some of the examples have additional dependencies. You can install them with:

```bash
pip install
```

0 comments on commit b936c5c

Please sign in to comment.