diff options
| author | microDev <70126934+microDev1@users.noreply.github.com> | 2020-10-17 02:22:15 +0530 |
|---|---|---|
| committer | microDev <70126934+microDev1@users.noreply.github.com> | 2020-10-17 02:22:15 +0530 |
| commit | de328c3be97891ecd7cb6a3daff9ce7d7faf7e76 (patch) | |
| tree | 1541a5bc12eba248bfdcd77bc230cb05f862c399 /README.rst | |
| parent | f0b37313c5adf2ad940d7279aa49620d36d7292d (diff) | |
Update port status in readme
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 27 |
1 files changed, 20 insertions, 7 deletions
diff --git a/README.rst b/README.rst index 347b8b8c6..99a35d6da 100644 --- a/README.rst +++ b/README.rst @@ -95,7 +95,7 @@ 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. +- Support status for ports is different. - 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 +137,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 +201,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 |