Skip to content

Commit e667bdf

Browse files
committed
Polish up the README since it was converted to RST from Markdown.
1 parent 20dd3b1 commit e667bdf

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

README.rst

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ Adafruit CircuitPython
33

44
|Build Status| |Doc Status| |Discord|
55

6-
**`Status <#status>`__** \| **`Supported Boards <#supported-boards>`__**
7-
\| **`Download <#download>`__** \|
8-
**`Documentation <#documentation>`__** \|
9-
**`Contributing <#contributing>`__** \| **`Differences from
10-
Micropython <#differences-from-micropython>`__** \| **`Project
11-
Structure <#project-structure>`__**
6+
`Status <#status>`__ \| `Supported Boards <#supported-boards>`__
7+
\| `Download <#download>`__ \|
8+
`Documentation <#documentation>`__ \|
9+
`Contributing <#contributing>`__ \| `Differences from
10+
Micropython <#differences-from-micropython>`__ \| `Project
11+
Structure <#project-structure>`__
1212

1313
**CircuitPython** is an *education friendly* open source derivative of
14-
``MicroPython <https://micropython.org>``\ *. CircuitPython supports use
14+
`MicroPython <https://micropython.org>`_. CircuitPython supports use
1515
on educational development boards designed and sold by
16-
``Adafruit <https://adafruit.com>``*. Adafruit CircuitPython features
16+
`Adafruit <https://adafruit.com>`_. Adafruit CircuitPython features
1717
unified Python core APIs and a growing list of Adafruit libraries and
1818
drivers of that work with it.
1919

@@ -126,17 +126,7 @@ Behavior
126126
API
127127
~~~
128128

129-
- Unified hardware APIs:
130-
```audioio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/audioio/__init__.html>`__,
131-
```analogio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/analogio/__init__.html>`__,
132-
```busio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/busio/__init__.html>`__,
133-
```digitalio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/digitalio/__init__.html>`__,
134-
```pulseio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/pulseio/__init__.html>`__,
135-
```touchio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/touchio/__init__.html>`__,
136-
```microcontroller`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/microcontroller/__init__.html>`__,
137-
```board`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/board/__init__.html>`__,
138-
```bitbangio`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/bitbangio/__init__.html>`__
139-
(Only available on atmel-samd21 and ESP8266 currently.)
129+
- 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>`_
140130
- No ``machine`` API on Atmel SAMD21 port.
141131

142132
Modules
@@ -155,7 +145,7 @@ Modules
155145
Therefore, code from CircuitPython is runnable on CPython but not
156146
necessarily the reverse.
157147
- tick count is available as
158-
```time.monotonic()`` <https://circuitpython.readthedocs.io/en/latest/shared-bindings/time/__init__.html#time.monotonic>`__
148+
`time.monotonic() <https://circuitpython.readthedocs.io/en/latest/shared-bindings/time/__init__.html#time.monotonic>`__
159149

160150
atmel-samd21 features
161151
~~~~~~~~~~~~~~~~~~~~~
@@ -243,7 +233,7 @@ The rest are here to maintain compatibility with the
243233
`MicroPython <https://github.com/micropython/micropython>`__ parent
244234
project.
245235

246-
**`⬆ back to top <#adafruit-circuitpython>`__**
236+
`⬆ back to top <#adafruit-circuitpython>`__
247237

248238
.. |Build Status| image:: https://travis-ci.org/adafruit/circuitpython.svg?branch=master
249239
:target: https://travis-ci.org/adafruit/circuitpython

0 commit comments

Comments
 (0)