Merge pull request #9 from adafruit/dherrada-patch-1

Removed building locally section from README, replaced with documenta…

Author: kattni

README.rst

@@ -27,64 +27,44 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
 This is easily achieved by downloading
 `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
 
-Usage Example
-=============
+Installing from PyPI
+====================
 
-See examples in github repository: https://github.com/adafruit/Adafruit_CircuitPython_STMPE610/tree/master/examples
-
-Contributing
-============
-
-Contributions are welcome! Please read our `Code of Conduct
-<https://github.com/adafruit/adafruit_CircuitPython_stmpe610/blob/master/CODE_OF_CONDUCT.md>`_
-before contributing to help this project stay welcoming.
-
-Building locally
-================
-
-Zip release files
------------------
-
-To build this library locally you'll need to install the
-`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
+On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
+PyPI <https://pypi.org/project/adafruit-circuitpython-stmpe610/>`_. To install for current user:
 
 .. code-block:: shell
 
-    python3 -m venv .env
-    source .env/bin/activate
-    pip install circuitpython-build-tools
+    pip3 install adafruit-circuitpython-stmpe610
 
-Once installed, make sure you are in the virtual environment:
+To install system-wide (this may be required in some cases):
 
 .. code-block:: shell
 
-    source .env/bin/activate
+    sudo pip3 install adafruit-circuitpython-stmpe610
 
-Then run the build:
-
-.. code-block:: shell
-
-    circuitpython-build-bundles --filename_prefix adafruit-circuitpython-stmpe610 --library_location .
-
-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):
+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
-    pip install Sphinx sphinx-rtd-theme
+    pip3 install adafruit-circuitpython-stmpe610
 
-Now, once you have the virtual environment activated:
+Usage Example
+=============
 
-.. code-block:: shell
+See examples in github repository: https://github.com/adafruit/Adafruit_CircuitPython_STMPE610/tree/master/examples
 
-    cd docs
-    sphinx-build -E -W -b html . _build/html
+Contributing
+============
+
+Contributions are welcome! Please read our `Code of Conduct
+<https://github.com/adafruit/adafruit_CircuitPython_stmpe610/blob/master/CODE_OF_CONDUCT.md>`_
+before contributing to help this project stay welcoming.
+
+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 <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.