aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDamien George2019-05-31 14:37:11 +1000
committerDamien George2019-06-03 14:44:44 +1000
commit41739506589ec8397613c86d8f682fb7f86c0a9f (patch)
tree0abff25a1816251a5cbd33f2dd4fe6ebd6e3d843 /README.md
parent0a6c479187d0b50a92b65f639e377678bde8034e (diff)
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.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 843511a60..aaf310b66 100644
--- a/README.md
+++ b/README.md
@@ -64,6 +64,17 @@ You will also need bash, gcc, and Python 3.3+ available as the command `python3`
(if your system only has Python 2.7 then invoke make with the additional option
`PYTHON=python2`).
+The MicroPython cross-compiler, mpy-cross
+-----------------------------------------
+
+Most ports require the MicroPython cross-compiler to be built first. This
+program, called mpy-cross, is used to pre-compile Python scripts to .mpy
+files which can then be included (frozen) into the firmware/executable for
+a port. To build mpy-cross use:
+
+ $ cd mpy-cross
+ $ make
+
The Unix version
----------------