djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #727 from sommersoft/build_doc

Browse Source 
Added git submodule Step To SAMD README
This commit is contained in:
Scott Shawcroft 2018-03-30 15:59:39 -07:00 committed by GitHub
commit 1489450693
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
ports/atmel-samd/README.rst
View File

@ -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: