Skip to content

Commit de328c3

Browse files
committed
Update port status in readme
1 parent f0b3731 commit de328c3

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.rst

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Differences from `MicroPython <https://github.com/micropython/micropython>`__
9595
CircuitPython:
9696

9797
- Supports native USB on all boards, allowing file editing without special tools.
98-
- Supports only SAMD21, SAMD51, nRF52840, CXD56, STM32F4 and i.MX RT ports.
98+
- Support status for ports is different.
9999
- Floats (aka decimals) are enabled for all builds.
100100
- Error messages are translated into 10+ languages.
101101
- Does not support concurrency within Python (including interrupts and threading). Some concurrency
@@ -137,8 +137,8 @@ Behavior
137137
API
138138
~~~
139139

140-
- Unified hardware APIs. Documented
141-
`on ReadTheDocs <https://circuitpython.readthedocs.io/en/latest/shared-bindings/index.html>`_.
140+
- Unified hardware APIs. Documented on
141+
`ReadTheDocs <https://circuitpython.readthedocs.io/en/latest/shared-bindings/index.html>`_.
142142
- API docs are rST within the C files in ``shared-bindings``.
143143
- No ``machine`` API.
144144

@@ -201,14 +201,27 @@ Ports
201201
Ports include the code unique to a microcontroller line and also
202202
variations based on the board.
203203

204-
- ``atmel-samd`` Support for SAMD21 and SAMD51 based boards.
205-
- ``nrf`` Support for the nRF52840 based boards.
206-
- ``unix`` Support for UNIX. Only used for automated testing.
204+
================ ============================================================
205+
Supported Support status
206+
================ ============================================================
207+
atmel-samd ``SAMD21`` stable | ``SAMD51`` stable
208+
cxd56 stable
209+
esp32s2 beta
210+
litex alpha
211+
mimxrt10xx alpha
212+
nrf stable
213+
stm ``F4`` stable | ``others`` beta
214+
unix alpha
215+
================ ============================================================
216+
217+
- ``stable`` Highly unlikely to have bugs or missing functionality.
218+
- ``beta`` Being actively improved but may be missing functionality and have bugs.
219+
- ``alpha`` Will have bugs and missing functionality.
207220

208221
The remaining port directories not listed above are in the repo to maintain compatibility with the
209222
`MicroPython <https://github.com/micropython/micropython>`__ parent project.
210223

211-
`back to top <#circuitpython>`__
224+
`Back to Top <#circuitpython>`__
212225

213226
.. |Build Status| image:: https://github.com/adafruit/circuitpython/workflows/Build%20CI/badge.svg
214227
:target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain

0 commit comments

Comments
 (0)