Skip to content

Commit 098fd3e

Browse files
authored
Merge pull request #3566 from microDev1/patch-1
Update port status in readme
2 parents 1092890 + 1338712 commit 098fd3e

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.rst

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ 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.
9998
- Floats (aka decimals) are enabled for all builds.
10099
- Error messages are translated into 10+ languages.
101100
- Does not support concurrency within Python (including interrupts and threading). Some concurrency
@@ -137,8 +136,8 @@ Behavior
137136
API
138137
~~~
139138

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

@@ -201,14 +200,27 @@ Ports
201200
Ports include the code unique to a microcontroller line and also
202201
variations based on the board.
203202

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.
203+
================ ============================================================
204+
Supported Support status
205+
================ ============================================================
206+
atmel-samd ``SAMD21`` stable | ``SAMD51`` stable
207+
cxd56 stable
208+
esp32s2 beta
209+
litex alpha
210+
mimxrt10xx alpha
211+
nrf stable
212+
stm ``F4`` stable | ``others`` beta
213+
unix alpha
214+
================ ============================================================
215+
216+
- ``stable`` Highly unlikely to have bugs or missing functionality.
217+
- ``beta`` Being actively improved but may be missing functionality and have bugs.
218+
- ``alpha`` Will have bugs and missing functionality.
207219

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

211-
`back to top <#circuitpython>`__
223+
`Back to Top <#circuitpython>`__
212224

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

0 commit comments

Comments
 (0)