diff --git a/README.md b/README.md index 7872f49..1a22ff4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ # BME680 -Python Library for the Bosch BME680 gas, temperature, pressure and humidity sensor. +[https://shop.pimoroni.com/products/bme680 + +The state-of-the-art BME680 breakout lets you measure temperature, pressure, humidity, and indoor air quality. + +## Installing + +### Manual install: + +#### Library install for Python 3: + +```bash +sudo pip3 install bme680 +``` + +#### Library install for Python 2: + +```bash +sudo pip2 install bme680 +``` + +### Development: + +If you want to contribute, or like living on the edge of your seat by having the latest code, you should clone this repository, `cd` to the library directory, and run: + +```bash +sudo python3 setup.py install +``` +(or `sudo python setup.py install` whichever your primary Python environment may be) + +In all cases you will have to enable the i2c bus. + +## Documentation & Support + +* Guides and tutorials - https://learn.pimoroni.com/bme680 +* Get help - http://forums.pimoroni.com/c/support