diff --git a/README.rst b/README.rst index 18517b7..64b897a 100644 --- a/README.rst +++ b/README.rst @@ -27,62 +27,44 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. -Usage Example -============= - -See examples/tsl2591_simpletest.py for a demo of the usage. - -Contributing -============ - -Contributions are welcome! Please read our `Code of Conduct -`_ -before contributing to help this project stay welcoming. - -Building locally -================ +Installing from PyPI +==================== -To build this library locally you'll need to install the -`circuitpython-build-tools `_ package. +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: .. code-block:: shell - python3 -m venv .env - source .env/bin/activate - pip install circuitpython-build-tools + pip3 install adafruit-circuitpython-tsl2591 -Once installed, make sure you are in the virtual environment: +To install system-wide (this may be required in some cases): .. code-block:: shell - source .env/bin/activate + sudo pip3 install adafruit-circuitpython-tsl2591 -Then run the build: - -.. code-block:: shell - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tsl2591 --library_location . - -Sphinx documentation ------------------------ - -Sphinx is used to build the documentation based on rST files and comments in the code. First, -install dependencies (feel free to reuse the virtual environment from above): +To install in a virtual environment in your current project: .. code-block:: shell + mkdir project-name && cd project-name python3 -m venv .env source .env/bin/activate - pip install Sphinx sphinx-rtd-theme + pip3 install adafruit-circuitpython-tsl2591 -Now, once you have the virtual environment activated: +Usage Example +============= -.. code-block:: shell +See examples/tsl2591_simpletest.py for a demo of the usage. - cd docs - sphinx-build -E -W -b html . _build/html +Contributing +============ -This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to -view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to -locally verify it will pass. +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Documentation +============= +For information on building library documentation, please check out `this guide `_.