diff --git a/README.rst b/README.rst index 3b15ab0..5009e85 100644 --- a/README.rst +++ b/README.rst @@ -26,69 +26,52 @@ 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' folder for full usage demo! +Installing from PyPI +==================== -API Reference -============= - -.. toctree:: - :maxdepth: 2 - - api +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: -Contributing -============ - -Contributions are welcome! Please read our `Code of Conduct -`_ -before contributing to help this project stay welcoming. +.. code-block:: shell -Building locally -================ + pip3 install adafruit-circuitpython-fingerprint -To build this library locally you'll need to install the -`circuitpython-build-tools `_ package. +To install system-wide (this may be required in some cases): .. code-block:: shell - python3 -m venv .env - source .env/bin/activate - pip install circuitpython-build-tools + sudo pip3 install adafruit-circuitpython-fingerprint -Once installed, make sure you are in the virtual environment: +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 + pip3 install adafruit-circuitpython-fingerprint -Then run the build: - -.. code-block:: shell - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-fingerprint --library_location . +Usage Example +============= -Sphinx documentation ------------------------ +See 'examples' folder for full usage demo! -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): +API Reference +============= -.. code-block:: shell +.. toctree:: + :maxdepth: 2 - python3 -m venv .env - source .env/bin/activate - pip install Sphinx sphinx-rtd-theme + api -Now, once you have the virtual environment activated: +Contributing +============ -.. code-block:: shell +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. - cd docs - sphinx-build -E -W -b html . _build/html +Documentation +============= -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. +For information on building library documentation, please check out `this guide `_.