Skip to content
This repository was archived by the owner on May 16, 2023. It is now read-only.

Commit 9dd7205

Browse files
authored
Merge pull request #11 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 47c2381 + 7926bae commit 9dd7205

File tree

1 file changed

+27
-20
lines changed

1 file changed

+27
-20
lines changed

README.rst

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,38 +29,45 @@ This is easily achieved by downloading
2929
**NOTE:** This library is not supported for smaller non-Express boards like
3030
the Trinket M0, Gemma M0, etc.
3131

32-
Usage Example
33-
=============
32+
Installing from PyPI
33+
====================
3434

35-
See examples/thermal_printer_simpletest.py for a demo of basic printer usage.
35+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
36+
PyPI <https://pypi.org/project/adafruit-circuitpython-thermal_printer/>`_. To install for current user:
3637

37-
Contributing
38-
============
38+
.. code-block:: shell
3939
40-
Contributions are welcome! Please read our `Code of Conduct
41-
<https://github.com/adafruit/Adafruit_CircuitPython_Thermal_Printer/blob/master/CODE_OF_CONDUCT.md>`_
42-
before contributing to help this project stay welcoming.
40+
pip3 install adafruit-circuitpython-thermal_printer
4341
42+
To install system-wide (this may be required in some cases):
4443

45-
Sphinx documentation
46-
-----------------------
44+
.. code-block:: shell
45+
46+
sudo pip3 install adafruit-circuitpython-thermal_printer
4747
48-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
49-
install dependencies (feel free to reuse the virtual environment from above):
48+
To install in a virtual environment in your current project:
5049

5150
.. code-block:: shell
5251
52+
mkdir project-name && cd project-name
5353
python3 -m venv .env
5454
source .env/bin/activate
55-
pip install Sphinx sphinx-rtd-theme
55+
pip3 install adafruit-circuitpython-thermal_printer
56+
57+
Usage Example
58+
=============
5659

57-
Now, once you have the virtual environment activated:
60+
See examples/thermal_printer_simpletest.py for a demo of basic printer usage.
5861

59-
.. code-block:: shell
62+
Contributing
63+
============
6064

61-
cd docs
62-
sphinx-build -E -W -b html . _build/html
65+
Contributions are welcome! Please read our `Code of Conduct
66+
<https://github.com/adafruit/Adafruit_CircuitPython_Thermal_Printer/blob/master/CODE_OF_CONDUCT.md>`_
67+
before contributing to help this project stay welcoming.
68+
69+
70+
Documentation
71+
=============
6372

64-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
65-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
66-
locally verify it will pass.
73+
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

0 commit comments

Comments
 (0)