From c70acab8b37c4f4e402a070b78024c4c1abf65c7 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 30 Mar 2018 22:16:36 +0000 Subject: [PATCH] updated README; added git submodule info --- ports/atmel-samd/README.rst | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/ports/atmel-samd/README.rst b/ports/atmel-samd/README.rst index c74407b0a0..e827b64995 100644 --- a/ports/atmel-samd/README.rst +++ b/ports/atmel-samd/README.rst @@ -141,16 +141,26 @@ The compiler can be changed using the ``CROSS_COMPILE`` variable when invoking Building -------- -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: +Before building the firmware for a given board, there are two additional steps. +These commands should be executed from the root directory of the repository +(``%clone location%/circuitpython/``). All other commands are run from the +``%clone location%/circuitpython/ports/atmel-samd/``directory. + +1. There are various submodules that reside in different repositories. In order + to have these submodules locally, you must pull them into your clone. + +.. code-block:: shell + + git submodule update --init --recursive + +2. 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: .. code-block:: shell 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 ports/atmel-samd/ directory. To build for the Arduino Zero: @@ -158,7 +168,8 @@ To build for the Arduino Zero: make -To build for other boards you must change it by setting ``BOARD``. For example: +To build for other boards you must change it by setting ``BOARD``. This command +is executed from the ``~/circuitpython/ports/atmel-samd`` directory. For example: .. code-block:: shell