djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Polish up the README since it was converted to RST from Markdown.

Browse Source
This commit is contained in:
Scott Shawcroft 2018-02-20 18:06:42 -08:00
parent 20dd3b1e43
commit e667bdfe05
1 changed files with 11 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.rst
View File

@ -3,17 +3,17 @@ Adafruit CircuitPython
|Build Status| |Doc Status| |Discord| |Build Status| |Doc Status| |Discord|
**`Status <#status>`__** \| **`Supported Boards <#supported-boards>`__** `Status <#status>`__ \| `Supported Boards <#supported-boards>`__
\| **`Download <#download>`__** \| \| `Download <#download>`__ \|
**`Documentation <#documentation>`__** \| `Documentation <#documentation>`__ \|
**`Contributing <#contributing>`__** \| **`Differences from `Contributing <#contributing>`__ \| `Differences from
Micropython <#differences-from-micropython>`__** \| **`Project Micropython <#differences-from-micropython>`__ \| `Project
Structure <#project-structure>`__** Structure <#project-structure>`__
**CircuitPython** is an *education friendly* open source derivative of **CircuitPython** is an *education friendly* open source derivative of
``MicroPython <https://micropython.org>``\ *. CircuitPython supports use `MicroPython <https://micropython.org>`_. CircuitPython supports use
on educational development boards designed and sold by on educational development boards designed and sold by
``Adafruit <https://adafruit.com>``*. Adafruit CircuitPython features `Adafruit <https://adafruit.com>`_. Adafruit CircuitPython features
unified Python core APIs and a growing list of Adafruit libraries and unified Python core APIs and a growing list of Adafruit libraries and
drivers of that work with it. drivers of that work with it.
@ -126,17 +126,7 @@ Behavior
API API
~~~ ~~~
- Unified hardware APIs: - Unified hardware APIs: `audioio <https://circuitpython.readthedocs.io/en/latest/shared-bindings/audioio/__init__.html>`_, `analogio <https://circuitpython.readthedocs.io/en/latest/shared-bindings/analogio/__init__.html>`_, `busio <https://circuitpython.readthedocs.io/en/latest/shared-bindings/busio/__init__.html>`_, `digitalio <https://circuitpython.readthedocs.io/en/latest/shared-bindings/digitalio/__init__.html>`_, `pulseio <https://circuitpython.readthedocs.io/en/latest/shared-bindings/pulseio/__init__.html>`_, `touchio <https://circuitpython.readthedocs.io/en/latest/shared-bindings/touchio/__init__.html>`_, `microcontroller <https://circuitpython.readthedocs.io/en/latest/shared-bindings/microcontroller/__init__.html>`_, `board <https://circuitpython.readthedocs.io/en/latest/shared-bindings/board/__init__.html>`_, `bitbangio <https://circuitpython.readthedocs.io/en/latest/shared-bindings/bitbangio/__init__.html>`_
```audioio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/audioio/__init__.html>`__,
```analogio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/analogio/__init__.html>`__,
```busio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/busio/__init__.html>`__,
```digitalio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/digitalio/__init__.html>`__,
```pulseio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/pulseio/__init__.html>`__,
```touchio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/touchio/__init__.html>`__,
```microcontroller`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/microcontroller/__init__.html>`__,
```board`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/board/__init__.html>`__,
```bitbangio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/bitbangio/__init__.html>`__
(Only available on atmel-samd21 and ESP8266 currently.)
- No ``machine`` API on Atmel SAMD21 port. - No ``machine`` API on Atmel SAMD21 port.
Modules Modules
@ -155,7 +145,7 @@ Modules
Therefore, code from CircuitPython is runnable on CPython but not Therefore, code from CircuitPython is runnable on CPython but not
necessarily the reverse. necessarily the reverse.
- tick count is available as - tick count is available as
```time.monotonic()`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/time/__init__.html#time.monotonic>`__ `time.monotonic() <https://circuitpython.readthedocs.io/en/latest/shared-bindings/time/__init__.html#time.monotonic>`__
atmel-samd21 features atmel-samd21 features
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
@ -243,7 +233,7 @@ The rest are here to maintain compatibility with the
`MicroPython <https://github.com/micropython/micropython>`__ parent `MicroPython <https://github.com/micropython/micropython>`__ parent
project. project.
**`⬆ back to top <#adafruit-circuitpython>`__** `⬆ back to top <#adafruit-circuitpython>`__
.. |Build Status| image:: https://travis-ci.org/adafruit/circuitpython.svg?branch=master .. |Build Status| image:: https://travis-ci.org/adafruit/circuitpython.svg?branch=master
:target: https://travis-ci.org/adafruit/circuitpython :target: https://travis-ci.org/adafruit/circuitpython