@@ -26,61 +26,44 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2626This is easily achieved by downloading
2727`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle >`_.
2828
29- Usage Example
30- =============
31-
32- See examples/tlc59711_simpletest.py for a demo of the usage.
33-
34- Contributing
35- ============
36-
37- Contributions are welcome! Please read our `Code of Conduct
38- <https://github.com/adafruit/Adafruit_CircuitPython_TLC59711/blob/master/CODE_OF_CONDUCT.md> `_
39- before contributing to help this project stay welcoming.
40-
41- Building locally
42- ================
43-
44- To build this library locally you'll need to install the
45- `circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools >`_ package.
46-
47- .. code-block :: shell
48-
49- python3 -m venv .env
50- source .env/bin/activate
51- pip install circuitpython-build-tools
29+ Installing from PyPI
30+ ====================
5231
53- Once installed, make sure you are in the virtual environment:
32+ On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
33+ PyPI <https://pypi.org/project/adafruit-circuitpython-tlc59711/> `_. To install for current user:
5434
5535.. code-block :: shell
5636
57- source .env/bin/activate
37+ pip3 install adafruit-circuitpython-tlc59711
5838
59- Then run the build :
39+ To install system-wide (this may be required in some cases) :
6040
6141.. code-block :: shell
6242
63- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tlc59711 --library_location .
64-
65- Sphinx documentation
66- -----------------------
43+ sudo pip3 install adafruit-circuitpython-tlc59711
6744
68- Sphinx is used to build the documentation based on rST files and comments in the code. First,
69- install dependencies (feel free to reuse the virtual environment from above):
45+ To install in a virtual environment in your current project:
7046
7147.. code-block :: shell
7248
49+ mkdir project-name && cd project-name
7350 python3 -m venv .env
7451 source .env/bin/activate
75- pip install Sphinx sphinx-rtd-theme
52+ pip3 install adafruit-circuitpython-tlc59711
7653
77- Now, once you have the virtual environment activated:
54+ Usage Example
55+ =============
7856
79- .. code-block :: shell
57+ See examples/tlc59711_simpletest.py for a demo of the usage.
8058
81- cd docs
82- sphinx-build -E -W -b html . _build/html
59+ Contributing
60+ ============
61+
62+ Contributions are welcome! Please read our `Code of Conduct
63+ <https://github.com/adafruit/Adafruit_CircuitPython_TLC59711/blob/master/CODE_OF_CONDUCT.md> `_
64+ before contributing to help this project stay welcoming.
65+
66+ Documentation
67+ =============
8368
84- This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
85- view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
86- locally verify it will pass.
69+ For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1 >`_.
0 commit comments