Skip to content

Commit 8b60b20

Browse files
committed
Tweaks based on review feedback.
1 parent bebf32a commit 8b60b20

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

README.rst

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ CircuitPython
55

66
|Build Status| |Doc Status| |License| |Discord|
77

8-
`circuitpython.org <https:/circuitpython.org>`_ \| `Get CircuitPython <#get-circuitpython>`__ \|
8+
`circuitpython.org <https:/circuitpython.org>`__ \| `Get CircuitPython <#get-circuitpython>`__ \|
99
`Documentation <#documentation>`__ \| `Contributing <#contributing>`__ \|
1010
`Branding <#branding>`__ \| `Differences from Micropython <#differences-from-micropython>`__ \|
1111
`Project Structure <#project-structure>`__
@@ -30,8 +30,8 @@ Get CircuitPython
3030
------------------
3131

3232
Official binaries for all supported boards are available through
33-
`circuitpython.org <https://circuitpython.org/downloads>`_. The site includes both stable, unstable
34-
and continuous builds. Full release notes and assets are available through
33+
`circuitpython.org/downloads <https://circuitpython.org/downloads>`_. The site includes stable, unstable and
34+
continuous builds. Full release notes and assets are available through
3535
`GitHub releases <https://github.com/adafruit/circuitpython/releases>`_ as well.
3636

3737
Documentation
@@ -77,8 +77,9 @@ If you'd like to use the term "CircuitPython" and Blinka for your product here i
7777
* Your product is supported by the primary
7878
`"adafruit/circuitpython" <https://github.com/adafruit/circuitpython>`_ repo. This way we can
7979
update any custom code as we update the CircuitPython internals.
80-
* Your product is listed on circuitpython.org. This is to ensure that a user of your product can
81-
always download the latest version of CircuitPython from the standard place.
80+
* Your product is listed on `circuitpython.org <https:/circuitpython.org>`__ (source
81+
`here <https://github.com/adafruit/circuitpython-org/>`_). This is to ensure that a user of your
82+
product can always download the latest version of CircuitPython from the standard place.
8283
* Your product has a user accessible USB plug which appears as a CIRCUITPY drive when plugged in.
8384

8485
If you choose not to meet these requirements, then we ask you call your version of CircuitPython
@@ -98,6 +99,8 @@ CircuitPython:
9899
- tracks MicroPython's releases (not master).
99100
- floats (aka decimals) are enabled for all builds.
100101
- error messages are translated into 10+ languages.
102+
- does not support concurrency within Python (including interrupts and threading). Some concurrency
103+
is achieved with native modules for tasks that require it such as audio file playback.
101104

102105
Behavior
103106
~~~~~~~~
@@ -122,19 +125,21 @@ Behavior
122125
causes nasty crashes by making it available through mass storage
123126
after the crash. A reset (the button) is needed after its fixed to
124127
get back into normal mode.
125-
- RGB status LED
126-
- Auto-reload after file write over mass storage. (Disable with
128+
- RGB status LED indicating CircuitPython state, and errors through a sequence of colored flashes.
129+
- Re-runs ``code.y`` or other main file after file system writes over USB mass storage. (Disable with
127130
``samd.disable_autoreload()``)
128-
- Wait state after boot and main run, before REPL.
129-
- Main is one of these: ``code.txt``, ``code.py``, ``main.py``,
131+
- Entering the REPL after the main code is finished requires a key press which enters the REPL and
132+
disables autoreload.
133+
- Main is one of these: ``code.txt``, **``code.py``**, ``main.py``,
130134
``main.txt``
131-
- Boot is one of these: ``settings.txt``, ``settings.py``, ``boot.py``,
135+
- Boot is one of these: ``settings.txt``, ``settings.py``, **``boot.py``**,
132136
``boot.txt``
133137

134138
API
135139
~~~
136140

137-
- 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>`_, `bleio <https://circuitpython.readthedocs.io/en/latest/shared-bindings/bleio/__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>`_
141+
- Unified hardware APIs. Documented
142+
`on ReadTheDocs <https://circuitpython.readthedocs.io/en/latest/shared-bindings/index.html>`_.
138143
- API docs are rST within the C files in ``shared-bindings``.
139144
- No ``machine`` API.
140145

@@ -201,10 +206,10 @@ variations based on the board.
201206
- ``nrf`` Support for the nRF52840 based boards.
202207
- ``unix`` Support for UNIX. Only used for automated testing.
203208

204-
The remaining, unlisted directories are in the repo to maintain compatibility with the
209+
The remaining port directories not listed above are in the repo to maintain compatibility with the
205210
`MicroPython <https://github.com/micropython/micropython>`__ parent project.
206211

207-
`back to top <#adafruit-circuitpython>`__
212+
`back to top <#circuitpython>`__
208213

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

0 commit comments

Comments
 (0)