README.md (1919B)
1 # Adafruit CCS811 [![Build Status](https://github.com/adafruit/Adafruit_CCS811/workflows/Arduino%20Library%20CI/badge.svg)](https://github.com/adafruit/Adafruit_CCS811/actions)[![Documentation](https://github.com/adafruit/ci-arduino/blob/master/assets/doxygen_badge.svg)](http://adafruit.github.io/Adafruit_CCS811/html/index.html) 2 3 4 <img src="https://cdn-shop.adafruit.com/970x728/3566-05.jpg" height="300"/> 5 6 This is a library for the Adafruit CCS811 gas sensor breakout board: 7 * https://www.adafruit.com/product/3566 8 9 Check out the [product guide on the Adafruit Learning System](https://learn.adafruit.com/adafruit-ccs811-air-quality-sensor) for our tutorials and wiring diagrams. 10 This chip uses **I2C** to communicate 11 12 Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit! 13 # Dependencies 14 * [Adafruit SSD1306](https://github.com/adafruit/Adafruit SSD1306) 15 * [Adafruit GFX Library](https://github.com/adafruit/Adafruit-GFX-Library) 16 17 # Contributing 18 19 Contributions are welcome! Please read our [Code of Conduct](https://github.com/adafruit/Adafruit_CCS811/blob/master/CODE_OF_CONDUCT.md>) 20 before contributing to help this project stay welcoming. 21 22 ## Documentation and doxygen 23 Documentation is produced by doxygen. Contributions should include documentation for any new code added. 24 25 Some examples of how to use doxygen can be found in these guide pages: 26 27 https://learn.adafruit.com/the-well-automated-arduino-library/doxygen 28 29 https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips 30 31 32 Written by Dean Miller for Adafruit Industries. 33 MIT license, all text above must be included in any redistribution. See license.txt for more information 34 All text above must be included in any redistribution 35 36 To install, use the Arduino Library Manager and search for "Adafruit CCS811" and install the library.