diff --git a/README.rst b/README.rst index 293ba92..945ef7d 100644 --- a/README.rst +++ b/README.rst @@ -25,71 +25,51 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. -Usage Example -============= - -.. code-block:: python - - import adafruit_miniqr - - qr = adafruit_miniqr.QRCode() - qr.add_data(b'https://www.adafruit.com') - qr.make() - print(qr.matrix) +Installing from PyPI +==================== -Contributing -============ - -Contributions are welcome! Please read our `Code of Conduct -`_ -before contributing to help this project stay welcoming. - -Building locally -================ - -Zip release files ------------------ - -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-miniqr -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-miniqr -Then run the build: +To install in a virtual environment in your current project: .. code-block:: shell - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-miniqr --library_location . + mkdir project-name && cd project-name + python3 -m venv .env + source .env/bin/activate + pip3 install adafruit-circuitpython-miniqr -Sphinx documentation ------------------------ +Usage Example +============= -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): +.. code-block:: python -.. code-block:: shell + import adafruit_miniqr - python3 -m venv .env - source .env/bin/activate - pip install Sphinx sphinx-rtd-theme + qr = adafruit_miniqr.QRCode() + qr.add_data(b'https://www.adafruit.com') + qr.make() + print(qr.matrix) -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 `_.