diff options
author | Raghuram Subramani <raghus2247@gmail.com> | 2022-06-19 19:47:51 +0530 |
---|---|---|
committer | Raghuram Subramani <raghus2247@gmail.com> | 2022-06-19 19:47:51 +0530 |
commit | 4fd287655a72b9aea14cdac715ad5b90ed082ed2 (patch) | |
tree | 65d393bc0e699dd12d05b29ba568e04cea666207 /circuitpython/frozen/Adafruit_CircuitPython_SimpleIO/README.rst | |
parent | 0150f70ce9c39e9e6dd878766c0620c85e47bed0 (diff) |
add circuitpython code
Diffstat (limited to 'circuitpython/frozen/Adafruit_CircuitPython_SimpleIO/README.rst')
-rw-r--r-- | circuitpython/frozen/Adafruit_CircuitPython_SimpleIO/README.rst | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/circuitpython/frozen/Adafruit_CircuitPython_SimpleIO/README.rst b/circuitpython/frozen/Adafruit_CircuitPython_SimpleIO/README.rst new file mode 100644 index 0000000..2988777 --- /dev/null +++ b/circuitpython/frozen/Adafruit_CircuitPython_SimpleIO/README.rst @@ -0,0 +1,76 @@ + +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-simpleio/badge/?version=latest + :target: https://docs.circuitpython.org/projects/simpleio/en/latest/ + :alt: Documentation Status + +.. image :: https://img.shields.io/discord/327254708534116352.svg + :target: https://adafru.it/discord + :alt: Discord + +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO/workflows/Build%20CI/badge.svg + :target: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO/actions/ + :alt: Build Status + +SimpleIO features a number of helpers to simplify hardware interactions. Many +of the functions and classes are inspired by Arduino APIs to make it easier to +move to CircuitPython from Arduino. + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_. + +Installing from PyPI +==================== + +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI <https://pypi.org/project/adafruit-circuitpython-simpleio/>`_. To install for current user: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-simpleio + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-simpleio + +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 + pip3 install adafruit-circuitpython-simpleio + +Usage Example +============= + +See the examples in the `examples/` folder for usage. + +Documentation +============= + +API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/simpleio/en/latest/>`_. + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +<https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO/blob/main/CODE_OF_CONDUCT.md>`_ +before contributing to help this project stay welcoming. + +Documentation +============= + +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>`_. |