diff --git a/README.rst b/README.rst index a9b7615..ad907ff 100644 --- a/README.rst +++ b/README.rst @@ -29,38 +29,45 @@ This is easily achieved by downloading **NOTE:** This library is not supported for smaller non-Express boards like the Trinket M0, Gemma M0, etc. -Usage Example -============= +Installing from PyPI +==================== -See examples/thermal_printer_simpletest.py for a demo of basic printer usage. +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: -Contributing -============ +.. code-block:: shell -Contributions are welcome! Please read our `Code of Conduct -`_ -before contributing to help this project stay welcoming. + pip3 install adafruit-circuitpython-thermal_printer +To install system-wide (this may be required in some cases): -Sphinx documentation ------------------------ +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-thermal_printer -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-thermal_printer + +Usage Example +============= -Now, once you have the virtual environment activated: +See examples/thermal_printer_simpletest.py for a demo of basic printer usage. -.. code-block:: shell +Contributing +============ - cd docs - sphinx-build -E -W -b html . _build/html +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + + +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 `_.