4625f97d09
README: Add a section describing MicroPython's values.
...
JavaScript code lint and formatting with Biome / eslint (push) Has been cancelled
Check code formatting / code-formatting (push) Has been cancelled
Check spelling with codespell / codespell (push) Has been cancelled
Build docs / build (push) Has been cancelled
Check examples / embedding (push) Has been cancelled
Package mpremote / build (push) Has been cancelled
.mpy file format and tools / test (push) Has been cancelled
Build ports metadata / build (push) Has been cancelled
alif port / build_alif (alif_ae3_build) (push) Has been cancelled
cc3200 port / build (push) Has been cancelled
esp32 port / build_idf (esp32_build_c2_c5_c6) (push) Has been cancelled
esp32 port / build_idf (esp32_build_cmod_spiram_s2) (push) Has been cancelled
esp32 port / build_idf (esp32_build_p4) (push) Has been cancelled
esp32 port / build_idf (esp32_build_s3_c3) (push) Has been cancelled
esp8266 port / build (push) Has been cancelled
mimxrt port / build (push) Has been cancelled
nrf port / build (push) Has been cancelled
powerpc port / build (push) Has been cancelled
qemu port / build_and_test_arm (bigendian) (push) Has been cancelled
qemu port / build_and_test_arm (sabrelite) (push) Has been cancelled
qemu port / build_and_test_arm (thumb_hardfp) (push) Has been cancelled
qemu port / build_and_test_arm (thumb_softfp) (push) Has been cancelled
qemu port / build_and_test_rv32 (push) Has been cancelled
qemu port / build_and_test_rv64 (push) Has been cancelled
renesas-ra port / build_renesas_ra_board (push) Has been cancelled
rp2 port / build (push) Has been cancelled
samd port / build (push) Has been cancelled
stm32 port / build_stm32 (stm32_misc_build) (push) Has been cancelled
stm32 port / build_stm32 (stm32_nucleo_build) (push) Has been cancelled
stm32 port / build_stm32 (stm32_pyb_build) (push) Has been cancelled
unix port / minimal (push) Has been cancelled
unix port / reproducible (push) Has been cancelled
unix port / standard (push) Has been cancelled
unix port / standard_v2 (push) Has been cancelled
unix port / coverage (push) Has been cancelled
unix port / coverage_32bit (push) Has been cancelled
unix port / nanbox (push) Has been cancelled
unix port / longlong (push) Has been cancelled
unix port / float (push) Has been cancelled
unix port / gil_enabled (push) Has been cancelled
unix port / stackless_clang (push) Has been cancelled
unix port / float_clang (push) Has been cancelled
unix port / settrace_stackless (push) Has been cancelled
unix port / repr_b (push) Has been cancelled
unix port / macos (push) Has been cancelled
unix port / qemu_mips (push) Has been cancelled
unix port / qemu_arm (push) Has been cancelled
unix port / qemu_riscv64 (push) Has been cancelled
unix port / sanitize_address (push) Has been cancelled
unix port / sanitize_undefined (push) Has been cancelled
webassembly port / build (push) Has been cancelled
windows port / build-vs (Debug, true, x64, dev, 2017, [15, 16)) (push) Has been cancelled
windows port / build-vs (Debug, true, x86, dev, 2017, [15, 16)) (push) Has been cancelled
windows port / build-vs (Debug, x64, dev, 2022, [17, 18)) (push) Has been cancelled
windows port / build-vs (Debug, x86, dev, 2022, [17, 18)) (push) Has been cancelled
windows port / build-vs (Release, true, x64, dev, 2017, [15, 16)) (push) Has been cancelled
windows port / build-vs (Release, true, x64, dev, 2019, [16, 17)) (push) Has been cancelled
windows port / build-vs (Release, true, x64, standard, 2017, [15, 16)) (push) Has been cancelled
windows port / build-vs (Release, true, x64, standard, 2019, [16, 17)) (push) Has been cancelled
windows port / build-vs (Release, true, x86, dev, 2017, [15, 16)) (push) Has been cancelled
windows port / build-vs (Release, true, x86, dev, 2019, [16, 17)) (push) Has been cancelled
windows port / build-vs (Release, true, x86, standard, 2017, [15, 16)) (push) Has been cancelled
windows port / build-vs (Release, true, x86, standard, 2019, [16, 17)) (push) Has been cancelled
windows port / build-vs (Release, x64, dev, 2022, [17, 18)) (push) Has been cancelled
windows port / build-vs (Release, x64, standard, 2022, [17, 18)) (push) Has been cancelled
windows port / build-vs (Release, x86, dev, 2022, [17, 18)) (push) Has been cancelled
windows port / build-vs (Release, x86, standard, 2022, [17, 18)) (push) Has been cancelled
windows port / build-mingw (i686, mingw32, dev) (push) Has been cancelled
windows port / build-mingw (i686, mingw32, standard) (push) Has been cancelled
windows port / build-mingw (x86_64, mingw64, dev) (push) Has been cancelled
windows port / build-mingw (x86_64, mingw64, standard) (push) Has been cancelled
windows port / cross-build-on-linux (push) Has been cancelled
zephyr port / build (push) Has been cancelled
Python code lint and formatting with ruff / ruff (push) Has been cancelled
This commit adds a section to the top-level README describing MicroPython's
general design philosophy and core values.
Thanks to @projectgus who suggested I add this.
Signed-off-by: Damien George <damien@micropython.org >
2026-03-11 16:36:38 +11:00
fc5195bfad
README: Remove warning about the project being in beta stage.
...
It's been over 12 years and the project is relatively stable now.
Signed-off-by: Damien George <damien@micropython.org >
2026-03-11 15:33:49 +11:00
0e1d857f80
README: Define and describe the port Tier levels.
...
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-10-23 11:23:17 +11:00
f0c6f16b9e
all: Remove Python 2.7 support.
...
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 >
2025-09-15 14:53:32 +10:00
6d799378ba
esp32: Add support for esp32c6.
...
This commit adds general support for ESP32-C6 SoCs.
Signed-off-by: Andrew Leech <andrew@alelec.net >
2024-10-09 23:29:38 +11:00
659113825d
qemu: Rename qemu-arm port to qemu.
...
Because this port now supports multiple architectures.
Signed-off-by: Damien George <damien@micropython.org >
2024-09-06 11:08:39 +10:00
3ea1ce63da
all: Remove remaining qemu-riscv references.
...
Signed-off-by: Damien George <damien@micropython.org >
2024-09-06 11:08:22 +10:00
206dc09456
README: Clean up a few bits of grammar.
...
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-26 14:40:39 +10:00
2d69aab7b3
qemu-riscv: Add new QEMU RV32 port.
...
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 >
2024-06-17 12:06:09 +10:00
e579ebb11b
teensy: Remove the teensy port.
...
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-31 13:04:41 +11:00
5232847771
README.md: Update CI badges.
...
- 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 >
2023-10-06 16:39:55 +11:00
64c62f8cf1
README: Simplify and update, and move unix section to separate file.
...
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-30 13:11:33 +10:00
888e831bf7
docs: Update links for Arm GCC toolchain.
...
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-08-11 14:27:06 +10:00
0dfd0447fa
README: Update link for ARM embedded toolchain to developer.arm.com.
2022-02-18 14:28:29 +11:00
c940597314
github/workflows: Switch from Coveralls to Codecov.
...
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 >
2021-06-25 16:17:54 +10:00
2f723d83c0
README: Update badges for new GitHub Actions workflows.
...
Signed-off-by: Damien George <damien@micropython.org >
2020-11-30 10:48:41 +11:00
c9611b280f
README: Change --help option to -h to match micropython executable.
...
The behaviour was changed in 83439e38fc
2020-05-11 21:57:38 +10:00
0bfd55afbe
README: Fix small typo, dfeault -> default.
2020-04-23 11:27:38 +10:00
6a1c7ea815
README: Update Travis CI links to point to travis-ci.com.
...
MicroPython now build at the .com rather than the .org.
2020-04-22 15:19:13 +10:00
d7a9388fe0
ports: Add new make target "submodules" which inits required modules.
2019-10-15 17:14:41 +11:00
4173950658
mpy-cross: Do not automatically build mpy-cross, rather do it manually.
...
Building mpy-cross automatically leads to some issues with the build
process and slows it down. Instead, require it to be built manually.
2019-06-03 14:44:44 +10:00
5368210e36
py/mkenv.mk: Change default PYTHON variable from "python" to "python3".
...
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.
2019-02-12 14:58:15 +11:00
d63ef86c6e
README: Remove text about selecting different ports in the docs.
2018-11-26 16:02:26 +11:00
51482ba925
README: Remove references to "make axtls", it's no longer needed.
...
Since 0be2ea50e9
2018-11-15 14:48:17 +11:00
4117a3d672
README: Update list of ports to include esp32 and nrf.
2018-07-18 17:22:33 +10:00
c53ca32561
README: Add gcc and arm-none-eabi-newlib to list of required components.
...
gcc is required for mpy-cross, and arm-none-eabi-newlib for ports using
arm-none-eabi-gcc.
2017-10-19 12:38:28 +11:00
829c329daf
README: Add explicit section on contributing.
...
To increase visibility of Contributors' Guidelines and Code Conventions
docs.
2017-10-15 10:17:24 +03:00
6e06512e0f
README: Update "Dependencies" section.
...
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-11 00:33:39 +03:00
4a93801c12
all: Update Makefiles and others to build with new ports/ dir layout.
...
Also renames "stmhal" to "stm32" in documentation and everywhere else.
2017-09-06 14:09:13 +10:00
02e9337494
README: Improve description of precompiled bytecode; mention mpy-cross.
2017-06-26 15:33:43 +10:00
7455e40186
README: Mention support for bytecode and frozen bytecode.
2017-06-24 17:33:47 +03:00
fb139a4ba6
README: Change Travis & Coveralls badges to not use link references.
...
Link references don't seem to work anymore.
2017-03-26 17:03:54 +11:00
fa17eabce9
README: Describe extmod/ dir.
2017-03-25 17:12:24 +03:00
c16d1c07ca
README: Add link to docs.micropython.org.
2017-03-25 17:07:57 +03:00
ddb56a0a84
README: Explicitly mention "await" support, and formatting for keywords.
2017-03-08 00:29:08 +01:00
5d0735b93a
README: "MicroPython board" is much more commonly known as PyBoard.
2016-10-21 04:40:10 +03:00
998578a2b8
README: Mention _thread module availability in select ports.
2016-10-12 19:12:20 +03:00
c528489eee
README: Remove issue-stats badges, the service is no longer available.
...
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-09-22 10:38:49 +10:00
282d81a40e
README: "quick build": Use "make axtls" after all.
...
"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-28 21:08:09 +03:00
e66b3042d6
README: Add "make deplibs" to quick build section.
2016-05-28 20:41:39 +03:00
772c73fa16
README: Add explicit note that subdirs contain more READMEs.
2016-05-14 06:33:47 +03:00
3f3ccef829
README: Mention support "async" keyword from Python 3.5.
2016-04-29 15:44:53 +03:00
c10d303e1b
README: Promote "docs" and "tests" to "major components".
2016-04-29 00:02:31 +03:00
97f88eebb6
README: Explicitly point to required dependencies section.
2016-04-18 22:37:42 +03:00
bb293e6bcf
stmhal: Add stmhal-specific README.md with extra details for this port.
2016-03-08 12:00:38 +00:00
2c72ae5c29
stmhal: Switch from dfu-util to tools/pydfu.py for deflt deploy method.
...
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-03-08 11:58:39 +00:00
53fec1ef48
README.md: Add link to micropython.org.
2016-02-17 23:01:49 +00:00
a9f3030371
docs: Add docs about REPL paste-mode and Control-C
2015-11-03 23:28:53 +00:00
98fb0bf68a
docs: Move instructions on generating the documentation to docs/README.md
2015-11-03 23:28:27 +00:00
1bfa6ae6e4
README: Fix typo in package name.
2015-11-04 00:54:56 +03:00
Damien George
Jeff Epler
Andrew Leech
tharuka
Alessandro Gatti
Jim Mussared
David Lechner
Bradley Wogsland
Hannah Suarez/hcs0
Krsna Mahapatra
Damien George
Paul Sokolovsky
Dave Hylands
Mike Bryant