Skip to content

Commit 3f82fe8

Browse files
committed
README.rst: document mpy-cross gotcha
This was biting me, leading to an odd error later on.
1 parent fa491b4 commit 3f82fe8

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

ports/atmel-samd/README.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,17 @@ The compiler can be changed using the ``CROSS_COMPILE`` variable when invoking
141141
Building
142142
--------
143143

144+
Before building the firmware for a given board the MicroPython cross-compiler
145+
must be built; it will be used to pre-compile some of the built-in scripts to
146+
bytecode. The cross-compiler is built and run on the host machine, using:
147+
148+
.. code-block:: shell
149+
150+
make -C mpy-cross
151+
152+
This command should be executed from the root directory of this repository.
153+
All other commands below should be executed from the ports/atmel-samd/ directory.
154+
144155
To build for the Arduino Zero:
145156

146157
.. code-block:: shell

0 commit comments

Comments
 (0)