diff options
| author | Scott Shawcroft <scott@tannewt.org> | 2018-03-30 15:59:39 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-30 15:59:39 -0700 |
| commit | 14894506932ee77bb7b0bb2bac5fef63acbab7fd (patch) | |
| tree | 159ac3cd86834d781fcfc556a2a654fd3b8f90bf | |
| parent | bee0d2edb44f2bfe9442749a4f15fff5572eab6b (diff) | |
| parent | 8af98d0dc95cd9b3417d938a869d3d5b39be0695 (diff) | |
Merge pull request #727 from sommersoft/build_doc
Added git submodule Step To SAMD README
| -rw-r--r-- | ports/atmel-samd/README.rst | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/ports/atmel-samd/README.rst b/ports/atmel-samd/README.rst index c74407b0a..d475e3816 100644 --- a/ports/atmel-samd/README.rst +++ b/ports/atmel-samd/README.rst @@ -141,16 +141,27 @@ 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 +(``circuitpython/``). + +1. There are various submodules that reside in different repositories. In order + to have these submodules locally, you must pull them into your clone, using: + +.. 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. + +Build commands are run from the ``circuitpython/ports/atmel-samd`` directory. To build for the Arduino Zero: |