summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2017-01-31 09:32:31 +1100
committerDamien George <damien.p.george@gmail.com>2017-01-31 09:32:31 +1100
commit326343feebdd1ad990864cc830a30b6a44d44918 (patch)
treef4b853430aaa7fc8af2c0f684557be0a4c923751
parent33b8e65bc0cb56c0c3da28511ce8f7c612c3e1c8 (diff)
downloadmicropython-326343feebdd1ad990864cc830a30b6a44d44918.tar.gz
micropython-326343feebdd1ad990864cc830a30b6a44d44918.zip
stmhal/README: Add paragraph about building mpy-cross.
-rw-r--r--stmhal/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/stmhal/README.md b/stmhal/README.md
index 6ebee35258..32b6d41766 100644
--- a/stmhal/README.md
+++ b/stmhal/README.md
@@ -17,6 +17,15 @@ to build each individual board.
Build instructions
------------------
+Before building the firmware for a given board the MicroPython cross-compiler
+must be built; it will be used to pre-compile some of the built-in scripts to
+bytecode. The cross-compiler is built and run on the host machine, using:
+```bash
+$ make -C mpy-cross
+```
+This command should be executed from the root directory of this repository.
+All other commands below should be executed from the stmhal/ directory.
+
An ARM compiler is required for the build, along with the associated binary
utilities. The default compiler is `arm-none-eabi-gcc`, which is available for
Arch Linux via the package `arm-none-eabi-gcc`, for Ubuntu via instructions