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

updated README; added git submodule info

Browse Source
This commit is contained in:
sommersoft 2018-03-30 22:16:36 +00:00
parent bee0d2edb4
commit c70acab8b3
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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