Skip to content

Commit a0c7064

Browse files
authored
Merge pull request #12 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents a71183e + 558c490 commit a0c7064

File tree

1 file changed

+28
-45
lines changed

1 file changed

+28
-45
lines changed

README.rst

Lines changed: 28 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2828
This is easily achieved by downloading
2929
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3030

31+
Installing from PyPI
32+
====================
33+
34+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
35+
PyPI <https://pypi.org/project/adafruit-circuitpython-focaltouch/>`_. To install for current user:
36+
37+
.. code-block:: shell
38+
39+
pip3 install adafruit-circuitpython-focaltouch
40+
41+
To install system-wide (this may be required in some cases):
42+
43+
.. code-block:: shell
44+
45+
sudo pip3 install adafruit-circuitpython-focaltouch
46+
47+
To install in a virtual environment in your current project:
48+
49+
.. code-block:: shell
50+
51+
mkdir project-name && cd project-name
52+
python3 -m venv .env
53+
source .env/bin/activate
54+
pip3 install adafruit-circuitpython-focaltouch
55+
3156
Usage Example
3257
=============
3358

@@ -55,49 +80,7 @@ Contributions are welcome! Please read our `Code of Conduct
5580
<https://github.com/adafruit/Adafruit_CircuitPython_FocalTouch/blob/master/CODE_OF_CONDUCT.md>`_
5681
before contributing to help this project stay welcoming.
5782

58-
Building locally
59-
================
60-
61-
To build this library locally you'll need to install the
62-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
63-
64-
.. code-block:: shell
65-
66-
python3 -m venv .env
67-
source .env/bin/activate
68-
pip install circuitpython-build-tools
69-
70-
Once installed, make sure you are in the virtual environment:
71-
72-
.. code-block:: shell
73-
74-
source .env/bin/activate
75-
76-
Then run the build:
77-
78-
.. code-block:: shell
79-
80-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-focaltouch --library_location .
81-
82-
Sphinx documentation
83-
-----------------------
84-
85-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
86-
install dependencies (feel free to reuse the virtual environment from above):
87-
88-
.. code-block:: shell
89-
90-
python3 -m venv .env
91-
source .env/bin/activate
92-
pip install Sphinx sphinx-rtd-theme
93-
94-
Now, once you have the virtual environment activated:
95-
96-
.. code-block:: shell
97-
98-
cd docs
99-
sphinx-build -E -W -b html . _build/html
83+
Documentation
84+
=============
10085

101-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
102-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
103-
locally verify it will pass.
86+
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)