Skip to content

Commit 1489450

Browse files
authored
Merge pull request adafruit#727 from sommersoft/build_doc
Added git submodule Step To SAMD README
2 parents bee0d2e + 8af98d0 commit 1489450

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

ports/atmel-samd/README.rst

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,16 +141,27 @@ 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:
144+
Before building the firmware for a given board, there are two additional steps.
145+
These commands should be executed from the root directory of the repository
146+
(``circuitpython/``).
147+
148+
1. There are various submodules that reside in different repositories. In order
149+
to have these submodules locally, you must pull them into your clone, using:
150+
151+
.. code-block:: shell
152+
153+
git submodule update --init --recursive
154+
155+
2. The MicroPython cross-compiler must be built; it will be used to pre-compile
156+
some of the built-in scripts to bytecode. The cross-compiler is built and
157+
run on the host machine, using:
147158

148159
.. code-block:: shell
149160
150161
make -C mpy-cross
151162
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.
163+
164+
Build commands are run from the ``circuitpython/ports/atmel-samd`` directory.
154165

155166
To build for the Arduino Zero:
156167

0 commit comments

Comments
 (0)