Developer Reference

For a detailed getting started guide, see Getting Started. This is a quick developer checklist on the basics of setting up and making a contribution.

Clone the repository:

$ git clone https://github.com/micropython/micropython.git
$ cd micropython

Build mpy-cross:

$ cd mpy-cross
$ make

Build MicroPython for the unix port:

$ cd ports/unix
$ make submodules
$ make

Run MicroPython:

$ ./micropython

On windows use wine and replace ./micropython with wineconsole --backend=curses ./micropython.exe.

Run the testsuite:

$ make test

Make sure you are in the port directory where MicroPython was built before running the tests.

Build the Docs:

$ cd docs
$ make html

General Project Quick References

Here are some links to references you will find useful.