From a738f4ab6ac2d6057becf6d2b7f769d151b9d240 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 20:03:00 -0400 Subject: [PATCH 1/2] Removed building locally section from README, replaced with documentation section --- README.rst | 24 +++--------------------- 1 file changed, 3 insertions(+), 21 deletions(-) diff --git a/README.rst b/README.rst index a9b7615..cc3eaf9 100644 --- a/README.rst +++ b/README.rst @@ -42,25 +42,7 @@ Contributions are welcome! Please read our `Code of Conduct before contributing to help this project stay welcoming. -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): - -.. code-block:: shell - - python3 -m venv .env - source .env/bin/activate - pip install Sphinx sphinx-rtd-theme - -Now, once you have the virtual environment activated: - -.. code-block:: shell - - 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 `_. From 7926baece0fa49417ba3f3c309a50b9086f4402f Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Fri, 18 Oct 2019 10:43:48 -0400 Subject: [PATCH 2/2] Added PyPi installation instructions --- README.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.rst b/README.rst index cc3eaf9..ad907ff 100644 --- a/README.rst +++ b/README.rst @@ -29,6 +29,31 @@ This is easily achieved by downloading **NOTE:** This library is not supported for smaller non-Express boards like the Trinket M0, Gemma M0, etc. +Installing from PyPI +==================== + +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 + + pip3 install adafruit-circuitpython-thermal_printer + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-thermal_printer + +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-thermal_printer + Usage Example =============