@@ -15,8 +15,9 @@ Introduction
1515
1616Driver for the AS726x spectral sensors
1717
18- Dependencies
19- =============
18+ Installation and Dependencies
19+ =============================
20+
2021This driver depends on:
2122
2223* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython >`_
@@ -27,14 +28,34 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2728This is easily achieved by downloading
2829`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle >`_.
2930
31+ Installing from PyPI
32+ --------------------
33+
34+ On the Raspberry Pi and other Linux systems, you can install the driver locally
35+ `from PyPI <https://pypi.org/project/adafruit-circuitpython-as726x/ >`_. To
36+ install system-wide, use:
37+
38+ .. code-block :: shell
39+
40+ sudo pip3 install adafruit-circuitpython-as726x
41+
42+ To install in a virtual environment in your current project:
43+
44+ .. code-block :: shell
45+
46+ mkdir project-name && cd project-name
47+ python3 -m venv .env
48+ source .env/bin/activate
49+ pip3 install adafruit-circuitpython-as726x
50+
3051 Contributing
3152============
3253
3354Contributions are welcome! Please read our `Code of Conduct
3455<https://github.com/adafruit/adafruit_CircuitPython_AS726x/blob/master/CODE_OF_CONDUCT.md> `_
3556before contributing to help this project stay welcoming.
3657
37- Building locally
58+ Building Locally
3859================
3960
4061Zip release files
@@ -61,8 +82,8 @@ Then run the build:
6182
6283 circuitpython-build-bundles --filename_prefix adafruit-circuitpython-as726x --library_location .
6384
64- Sphinx documentation
65- -----------------------
85+ Sphinx Documentation
86+ --------------------
6687
6788Sphinx is used to build the documentation based on rST files and comments in the code. First,
6889install dependencies (feel free to reuse the virtual environment from above):
0 commit comments