diff options
| author | Scott Shawcroft <scott@adafruit.com> | 2020-10-20 10:34:24 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-20 10:34:24 -0700 |
| commit | 098fd3efd2d24ede727d4f82cd6497f6dd360370 (patch) | |
| tree | 1e9d60f20e76c7a01ea6afe215ab5aea8a6e11f6 | |
| parent | 109289026636344758a39a100bb3651958b2978a (diff) | |
| parent | 13387121fe653c3380e4248abc2db69687cc27cf (diff) | |
Merge pull request #3566 from microDev1/patch-1
Update port status in readme
| -rw-r--r-- | README.rst | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/README.rst b/README.rst index 347b8b8c6..d21e8d8d3 100644 --- a/README.rst +++ b/README.rst @@ -95,7 +95,6 @@ Differences from `MicroPython <https://github.com/micropython/micropython>`__ CircuitPython: - Supports native USB on all boards, allowing file editing without special tools. -- Supports only SAMD21, SAMD51, nRF52840, CXD56, STM32F4 and i.MX RT ports. - Floats (aka decimals) are enabled for all builds. - Error messages are translated into 10+ languages. - Does not support concurrency within Python (including interrupts and threading). Some concurrency @@ -137,8 +136,8 @@ Behavior API ~~~ -- Unified hardware APIs. Documented - `on ReadTheDocs <https://circuitpython.readthedocs.io/en/latest/shared-bindings/index.html>`_. +- Unified hardware APIs. Documented on + `ReadTheDocs <https://circuitpython.readthedocs.io/en/latest/shared-bindings/index.html>`_. - API docs are rST within the C files in ``shared-bindings``. - No ``machine`` API. @@ -201,14 +200,27 @@ Ports Ports include the code unique to a microcontroller line and also variations based on the board. -- ``atmel-samd`` Support for SAMD21 and SAMD51 based boards. -- ``nrf`` Support for the nRF52840 based boards. -- ``unix`` Support for UNIX. Only used for automated testing. +================ ============================================================ +Supported Support status +================ ============================================================ +atmel-samd ``SAMD21`` stable | ``SAMD51`` stable +cxd56 stable +esp32s2 beta +litex alpha +mimxrt10xx alpha +nrf stable +stm ``F4`` stable | ``others`` beta +unix alpha +================ ============================================================ + +- ``stable`` Highly unlikely to have bugs or missing functionality. +- ``beta`` Being actively improved but may be missing functionality and have bugs. +- ``alpha`` Will have bugs and missing functionality. The remaining port directories not listed above are in the repo to maintain compatibility with the `MicroPython <https://github.com/micropython/micropython>`__ parent project. -`back to top <#circuitpython>`__ +`Back to Top <#circuitpython>`__ .. |Build Status| image:: https://github.com/adafruit/circuitpython/workflows/Build%20CI/badge.svg :target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain |