The MicroPython repository is divided into a number of directories, each with its own function. Some of them include:
Docs, Logo and Examples¶
The user documentation for all ports lives in the
docs directory, with some
example code in the
examples directory. The
logo directory contains the
MicroPython logo in various formats.
All tests live in the
py directory contains the bulk of code for the compiler, runtime
environment and core library of MicroPython. This is where we will be looking
for API functions and macros.
The directories such as
windows contain code
and tools specific to particular ports of MicroPython. If you are working on a
feature to be added for a specific hardware, this is probably the best place to
put your files.
minimal directory contains the minimum of files that a new port needs.
You can use this as a template for starting new ports of MicroPython.
extmod directory contains source of MicroPython modules that may are
not part of the core library, but are useful for multiple ports. The
drivers directory has code for libraries that communicate with various
additional hardware, such as displays or sensors.
Tools and Utilities¶
tools directory contains various tools useful for working with
mpy-cross directory has code for the MicroPython
cross-compiler, which can be used to generate frozen bytecode modules.