Merge pull request #133 from pimoroni/patch-install

Update install instructions for #132

Author: Gadgetoid

README.md

@@ -2,8 +2,8 @@
 
 Designed for environmental monitoring, Enviro+ lets you measure air quality (pollutant gases and particulates), temperature, pressure, humidity, light, and noise level. Learn more - https://shop.pimoroni.com/products/enviro-plus
 
-[![Build Status](https://travis-ci.com/pimoroni/enviroplus-python.svg?branch=master)](https://travis-ci.com/pimoroni/enviroplus-python)
-[![Coverage Status](https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/enviroplus-python?branch=master)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/enviroplus-python/test.yml?branch=main)](https://github.com/pimoroni/enviroplus-python/actions/workflows/test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=main)](https://coveralls.io/github/pimoroni/enviroplus-python?branch=main)
 [![PyPi Package](https://img.shields.io/pypi/v/enviroplus.svg)](https://pypi.python.org/pypi/enviroplus)
 [![Python Versions](https://img.shields.io/pypi/pyversions/enviroplus.svg)](https://pypi.python.org/pypi/enviroplus)
 
@@ -18,25 +18,30 @@ You are best using the "One-line" install method if you want all of the UART ser
 
 :warning: This library now supports Python 3 only, Python 2 is EOL - https://www.python.org/doc/sunset-python-2/
 
-## One-line (Installs from GitHub)
-
-```bash
-curl -sSL https://get.pimoroni.com/enviroplus | bash
-```
-
-**Note** report issues with one-line installer here: https://github.com/pimoroni/get
-
-## Or... Install and configure dependencies from GitHub:
+## Install and configure dependencies from GitHub:
 
 * `git clone https://github.com/pimoroni/enviroplus-python`
 * `cd enviroplus-python`
-* `sudo ./install.sh`
+* `./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
+```
 
 **Note** Raspbian/Raspberry Pi OS Lite users may first need to install git: `sudo apt install git`
 
 ## Or... Install from PyPi and configure manually:
 
-* Run `sudo python3 -m pip install enviroplus`
+* `python3 -m venv --system-site-packages $HOME/.virtualenvs/pimoroni`
+* Run `python3 -m pip install enviroplus`
+
+And install additional dependencies:
+
+```bash
+sudo apt install python3-numpy python3-smbus python3-pil python3-setuptools
+```
 
 **Note** this will not perform any of the required configuration changes on your Pi, you may additionally need to:
 
@@ -45,15 +50,17 @@ curl -sSL https://get.pimoroni.com/enviroplus | bash
 
 And if you're using a PMS5003 sensor you will need to:
 
-* Enable serial: `raspi-config nonint set_config_var enable_uart 1 /boot/config.txt`
-* Disable serial terminal: `sudo raspi-config nonint do_serial 1`
+### Bookworm
+
+* Enable serial: `raspi-config nonint do_serial_hw 0`
+* Disable serial terminal: `raspi-config nonint do_serial_cons 1`
 * Add `dtoverlay=pi3-miniuart-bt` to your `/boot/config.txt`
 
-And install additional dependencies:
+### Bullseye
 
-```bash
-sudo apt install python3-numpy python3-smbus python3-pil python3-setuptools
-```
+* Enable serial: `raspi-config nonint set_config_var enable_uart 1 /boot/config.txt`
+* Disable serial terminal: `sudo raspi-config nonint do_serial 1`
+* Add `dtoverlay=pi3-miniuart-bt` to your `/boot/config.txt`
 
 ## Alternate Software & User Projects
 

pyproject.toml

@@ -141,5 +141,5 @@ commands = [
 	"sudo raspi-config nonint do_i2c 0",
 	"printf \"Setting up serial for PMS5003..\\n\"",
 	"sudo raspi-config nonint do_serial_cons 1",
-	"sudo raspi-config nonint do_serial_hw 1"
+	"sudo raspi-config nonint do_serial_hw 0"
 ]