Skip to content

Commit 9524e0d

Browse files
authored
Merge pull request #13 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 1669893 + e3e3cae commit 9524e0d

File tree

1 file changed

+23
-44
lines changed

1 file changed

+23
-44
lines changed

README.rst

Lines changed: 23 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Introduction
1616
CircuitPython module for the Melexis MLX90614 Contact-less Infrared Temperature sensor. See
1717
examples/mlx90614_simpletest.py for a demo of the usage.
1818

19-
2019
Dependencies
2120
=============
2221
This driver depends on:
@@ -28,64 +27,44 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2827
This is easily achieved by downloading
2928
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3029

31-
Usage Example
32-
=============
33-
34-
See examples/mlx90614_simpletest.py for a demo of the usage.
35-
36-
Contributing
37-
============
38-
39-
Contributions are welcome! Please read our `Code of Conduct
40-
<https://github.com/adafruit/adafruit_CircuitPython_MLX90614/blob/master/CODE_OF_CONDUCT.md>`_
41-
before contributing to help this project stay welcoming.
42-
43-
Building locally
44-
================
45-
46-
Zip release files
47-
-----------------
48-
49-
To build this library locally you'll need to install the
50-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
51-
52-
.. code-block:: shell
53-
54-
python3 -m venv .env
55-
source .env/bin/activate
56-
pip install circuitpython-build-tools
30+
Installing from PyPI
31+
====================
5732

58-
Once installed, make sure you are in the virtual environment:
33+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
34+
PyPI <https://pypi.org/project/adafruit-circuitpython-mlx90614/>`_. To install for current user:
5935

6036
.. code-block:: shell
6137
62-
source .env/bin/activate
38+
pip3 install adafruit-circuitpython-mlx90614
6339
64-
Then run the build:
40+
To install system-wide (this may be required in some cases):
6541

6642
.. code-block:: shell
6743
68-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-mlx90614 --library_location .
69-
70-
Sphinx documentation
71-
-----------------------
44+
sudo pip3 install adafruit-circuitpython-mlx90614
7245
73-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
74-
install dependencies (feel free to reuse the virtual environment from above):
46+
To install in a virtual environment in your current project:
7547

7648
.. code-block:: shell
7749
50+
mkdir project-name && cd project-name
7851
python3 -m venv .env
7952
source .env/bin/activate
80-
pip install Sphinx sphinx-rtd-theme
53+
pip3 install adafruit-circuitpython-mlx90614
8154
82-
Now, once you have the virtual environment activated:
55+
Usage Example
56+
=============
8357

84-
.. code-block:: shell
58+
See examples/mlx90614_simpletest.py for a demo of the usage.
8559

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

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