Skip to content

Commit bfb9150

Browse files
authored
Merge pull request #17 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 41771c7 + ef5ddbd commit bfb9150

File tree

1 file changed

+29
-45
lines changed

1 file changed

+29
-45
lines changed

README.rst

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

40+
Installing from PyPI
41+
====================
42+
43+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
44+
PyPI <https://pypi.org/project/adafruit-circuitpython-rfm69/>`_. To install for current user:
45+
46+
.. code-block:: shell
47+
48+
pip3 install adafruit-circuitpython-rfm69
49+
50+
To install system-wide (this may be required in some cases):
51+
52+
.. code-block:: shell
53+
54+
sudo pip3 install adafruit-circuitpython-rfm69
55+
56+
To install in a virtual environment in your current project:
57+
58+
.. code-block:: shell
59+
60+
mkdir project-name && cd project-name
61+
python3 -m venv .env
62+
source .env/bin/activate
63+
pip3 install adafruit-circuitpython-rfm69
64+
65+
4066
Usage Example
4167
=============
4268
See examples/rfm69_simpletest.py for a simple demo of the usage.
@@ -61,49 +87,7 @@ Contributions are welcome! Please read our `Code of Conduct
6187
<https://github.com/adafruit/Adafruit_CircuitPython_RFM69/blob/master/CODE_OF_CONDUCT.md>`_
6288
before contributing to help this project stay welcoming.
6389

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

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