diff --git a/README.md b/README.md index af65d59..aba5a23 100644 --- a/README.md +++ b/README.md @@ -7,23 +7,52 @@ Suitable for measuring ambient temperature, barometric pressure, and humidity, the BME280 is a great indoor environmental sensor. -# Pre-requisites +## Installing -You must enable: +We'd recommend using this library with Raspberry Pi OS Bookworm or later. It requires Python ≥3.7. -* i2c: `sudo raspi-config nonint do_i2c 0` +## Full install (recommended): -You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configuration UI to enable interfaces. +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/bme280-python +cd bme280-python +./install.sh +``` + +**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples: + +``` +source ~/.virtualenvs/pimoroni/bin/activate +``` -# Installing +## Development: -Stable library from PyPi, the smbus library is also needed: +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: -* Just run `python3 -m pip install pimoroni-bme280` +```bash +git clone https://github.com/pimoroni/bme280-python +cd bme280-python +./install.sh --unstable +``` -Latest/development library from GitHub: +## Install stable library from PyPi and configure manually -* `git clone https://github.com/pimoroni/bme280-python` -* `cd bme280-python` -* `sudo ./install.sh` +* 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 pimoroni-bme280` + +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` + +You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configuration UI to enable interfaces.