djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update port status in readme

This commit is contained in:
microDev 2020-10-17 02:22:15 +05:30
parent f0b37313c5
commit de328c3be9
No known key found for this signature in database
GPG Key ID: 2C0867BE60967730
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.rst
View File

@ -95,7 +95,7 @@ Differences from `MicroPython <https://github.com/micropython/micropython>`__
CircuitPython: CircuitPython:
- Supports native USB on all boards, allowing file editing without special tools. - 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. - Floats (aka decimals) are enabled for all builds.
- Error messages are translated into 10+ languages. - Error messages are translated into 10+ languages.
- Does not support concurrency within Python (including interrupts and threading). Some concurrency - Does not support concurrency within Python (including interrupts and threading). Some concurrency
@ -137,8 +137,8 @@ Behavior
API API
~~~ ~~~
- Unified hardware APIs. Documented - Unified hardware APIs. Documented on
`on ReadTheDocs <https://circuitpython.readthedocs.io/en/latest/shared-bindings/index.html>`_. `ReadTheDocs <https://circuitpython.readthedocs.io/en/latest/shared-bindings/index.html>`_.
- API docs are rST within the C files in ``shared-bindings``. - API docs are rST within the C files in ``shared-bindings``.
- No ``machine`` API. - No ``machine`` API.
@ -201,14 +201,27 @@ Ports
Ports include the code unique to a microcontroller line and also Ports include the code unique to a microcontroller line and also
variations based on the board. variations based on the board.
- ``atmel-samd`` Support for SAMD21 and SAMD51 based boards. ================ ============================================================
- ``nrf`` Support for the nRF52840 based boards. Supported Support status
- ``unix`` Support for UNIX. Only used for automated testing. ================ ============================================================
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 The remaining port directories not listed above are in the repo to maintain compatibility with the
`MicroPython <https://github.com/micropython/micropython>`__ parent project. `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 .. |Build Status| image:: https://github.com/adafruit/circuitpython/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain :target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain