summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2025-10-23README: Define and describe the port Tier levels.Damien George
MicroPython has quite a few ports now (20 of them), but not all are in the same stage of development. This commit attempts to define port Tier levels and assign a Tier to each of the existing ports. The main aim here is to set expectations for the level of support and development each port gets. And also lower the bar of entry for new ports so they can enter at a low Tier and gradually rise up to Tier 1. See prior art here: - https://peps.python.org/pep-0011/ - https://doc.rust-lang.org/rustc/target-tier-policy.html - https://docs.zephyrproject.org/latest/project/release_process.html#hardware-support-tiers Signed-off-by: Damien George <damien@micropython.org> Signed-off-by: Angus Gratton <angus@redyak.com.au>
2025-09-15all: Remove Python 2.7 support.Jeff Epler
Python 2.7 has been EOL since January 2020. Ubuntu oldoldlts (Focal Fossa, 20.04) has Python 3.8. Debian oldoldstable (Buster, from 2019) has Python 3.7. RHEL 8 (from 2019) has Python 3.6. It's easier than ever to install a modern Python using uv. Given this, it seems like a fine idea to drop Python 2.7 support. Even though the build is not tested on Python as old as 3.3, I left comments stating that "3.3+" is the baseline Python version. However, it might make sense to bump this to e.g., 3.10, the oldest Python 3 version used during CI. Or, using uv or another method actually test on the oldest Python interpreter that is desirable to support (uv goes back to Python 3.7 easily; in October 2025, the oldest supported Python interpreter version will be 3.10) Signed-off-by: Jeff Epler <jepler@gmail.com>
2024-10-09esp32: Add support for esp32c6.Andrew Leech
This commit adds general support for ESP32-C6 SoCs. Signed-off-by: Andrew Leech <andrew@alelec.net>
2024-09-06qemu: Rename qemu-arm port to qemu.Damien George
Because this port now supports multiple architectures. Signed-off-by: Damien George <damien@micropython.org>
2024-09-06all: Remove remaining qemu-riscv references.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2024-06-26README: Clean up a few bits of grammar.tharuka
The word "Select" could be confusing in this context, eg it could be misunderstood as the `select` module. Signed-off-by: tharuka <78165134+tharuka-pavith@users.noreply.github.com>
2024-06-17qemu-riscv: Add new QEMU RV32 port.Alessandro Gatti
This adds a QEMU-based bare metal RISC-V 32 bits port. For the time being only QEMU's "virt" 32 bits board is supported, using the ilp32 ABI and the RV32IMC architecture. The top-level README and the run-tests.py files are updated for this new port. Signed-off-by: Alessandro Gatti <a.gatti@frob.it>
2023-10-31teensy: Remove the teensy port.Jim Mussared
This port is largely unmaintained, has limited features (the only hardware support is for GPIO and timer, and no machine module), only supports a small number of Teensy boards, and can be confused with the mimxrt support for Teensy 4.x. Signed-off-by: Jim Mussared <jim.mussared@gmail.com> Signed-off-by: Damien George <damien@micropython.org>
2023-10-06README.md: Update CI badges.Jim Mussared
- Fix URL for the unix badge. - Add stm32 CI badge. - Add docs CI badge (linking to the documentation) - Make docs CI run on push (so we get a badge generated). This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2022-08-30README: Simplify and update, and move unix section to separate file.Jim Mussared
Changes are: - Remove unix- and stm32-specific sections (move unix to its own README.md), stm32 was duplicated. - Add links to GitHub Discussions and Discord. - Update information about the project. - Add a getting started section. - Explain `make submodules`. Signed-off-by: Jim Mussared <jim.mussared@gmail.com> Signed-off-by: Damien George <damien@micropython.org>
2022-08-11docs: Update links for Arm GCC toolchain.David Lechner
The separate A and RM toolchains have been discontinued and replaced by a single toolchain. This updates the links to the RM toolchain to the new toolchain. Signed-off-by: David Lechner <david@pybricks.com>
2022-02-18README: Update link for ARM embedded toolchain to developer.arm.com.Bradley Wogsland
2021-06-25github/workflows: Switch from Coveralls to Codecov.Damien George
As discussed in #7455, Coveralls doesn't work properly anymore, it has many spurious errors with reduced coverage. Signed-off-by: Damien George <damien@micropython.org>
2020-11-30README: Update badges for new GitHub Actions workflows.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2020-05-11README: Change --help option to -h to match micropython executable.Hannah Suarez/hcs0
The behaviour was changed in 83439e38fc025bda79eec0096b8cc60379757206
2020-04-23README: Fix small typo, dfeault -> default.Krsna Mahapatra
2020-04-22README: Update Travis CI links to point to travis-ci.com.Damien George
MicroPython now build at the .com rather than the .org.
2019-10-15ports: Add new make target "submodules" which inits required modules.Damien George
2019-06-03mpy-cross: Do not automatically build mpy-cross, rather do it manually.Damien George
Building mpy-cross automatically leads to some issues with the build process and slows it down. Instead, require it to be built manually.
2019-02-12py/mkenv.mk: Change default PYTHON variable from "python" to "python3".Damien George
This change makes it so that python3 is required by default to build MicroPython. Python 2 can be used by specifying make PYTHON=python2. This comes about due to a recent-ish change to PEP 394 that makes the python command more optional than before (even with Python 2 installed); see https://github.com/python/peps/commit/cd59ec03c8ff1e75089d5872520cd0706774b35b#diff-1d22f7bd72cbc900670f058b1107d426 Since the command python is no longer required to be provided by a distribution we need to use either python2 or python3 as commands. And python3 seems the obvious choice.
2018-11-26README: Remove text about selecting different ports in the docs.Damien George
2018-11-15README: Remove references to "make axtls", it's no longer needed.Damien George
Since 0be2ea50e98f9d742b9611d0289853a11d9e7f53 axtls is automatically built as part of the usual "make" build process.
2018-07-18README: Update list of ports to include esp32 and nrf.Damien George
2017-10-19README: Add gcc and arm-none-eabi-newlib to list of required components.Damien George
gcc is required for mpy-cross, and arm-none-eabi-newlib for ports using arm-none-eabi-gcc.
2017-10-15README: Add explicit section on contributing.Paul Sokolovsky
To increase visibility of Contributors' Guidelines and Code Conventions docs.
2017-09-11README: Update "Dependencies" section.Paul Sokolovsky
Given that various ports now require submodules, rewrite the section to be more generic. Also, add git submodule update command to other sections for easy user start.
2017-09-06all: Update Makefiles and others to build with new ports/ dir layout.Damien George
Also renames "stmhal" to "stm32" in documentation and everywhere else.
2017-06-26README: Improve description of precompiled bytecode; mention mpy-cross.Damien George
2017-06-24README: Mention support for bytecode and frozen bytecode.Paul Sokolovsky
2017-03-26README: Change Travis & Coveralls badges to not use link references.Damien George
Link references don't seem to work anymore.
2017-03-25README: Describe extmod/ dir.Paul Sokolovsky
2017-03-25README: Add link to docs.micropython.org.Paul Sokolovsky
2017-03-08README: Explicitly mention "await" support, and formatting for keywords.Paul Sokolovsky
2016-10-21README: "MicroPython board" is much more commonly known as PyBoard.Paul Sokolovsky
2016-10-12README: Mention _thread module availability in select ports.Paul Sokolovsky
2016-09-22README: Remove issue-stats badges, the service is no longer available.Damien George
The issue-stats service is not well maintained and likely the situation won't improve in the future. See: https://github.com/hstove/issue_stats/issues/41 https://github.com/hstove/issue_stats/issues/46
2016-05-28README: "quick build": Use "make axtls" after all.Paul Sokolovsky
"make deplibs" also builds libffi, and that requires GNU autotools. As we use host libffi by default, skip requiring users to build it for now.
2016-05-28README: Add "make deplibs" to quick build section.Paul Sokolovsky
2016-05-14README: Add explicit note that subdirs contain more READMEs.Paul Sokolovsky
2016-04-29README: Mention support "async" keyword from Python 3.5.Paul Sokolovsky
2016-04-29README: Promote "docs" and "tests" to "major components".Paul Sokolovsky
2016-04-18README: Explicitly point to required dependencies section.Paul Sokolovsky
2016-03-08stmhal: Add stmhal-specific README.md with extra details for this port.Damien George
2016-03-08stmhal: Switch from dfu-util to tools/pydfu.py for deflt deploy method.Damien George
tools/pydfu.py is now the recommended way of deploying a DFU file. Old behaviour of dfu-util can be obtained by passing USE_PYDFU=0 when invoking make. The main README.md file has been updated to reflect this change.
2016-02-17README.md: Add link to micropython.org.Damien George
2015-11-03docs: Add docs about REPL paste-mode and Control-CDave Hylands
2015-11-03docs: Move instructions on generating the documentation to docs/README.mdDave Hylands
2015-11-04README: Fix typo in package name.Mike Bryant
2015-10-31README: Adjust suggested path for generated docs.Paul Sokolovsky
2015-10-21README: Document how to enable/build external dependencies.Paul Sokolovsky