From c70acab8b37c4f4e402a070b78024c4c1abf65c7 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 30 Mar 2018 22:16:36 +0000 Subject: 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 c74407b0a..e827b6499 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 -- cgit v1.2.3 From 7c0be04696c0b1eec6be4d0262630dfd766d0cca Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 30 Mar 2018 22:21:35 +0000 Subject: verbiage cleanup --- ports/atmel-samd/README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ports/atmel-samd/README.rst b/ports/atmel-samd/README.rst index e827b6499..271187b9d 100644 --- a/ports/atmel-samd/README.rst +++ b/ports/atmel-samd/README.rst @@ -143,11 +143,11 @@ Building 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. +(``%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. + to have these submodules locally, you must pull them into your clone, using: .. code-block:: shell -- cgit v1.2.3 From a5b60647be4c240adccb99cba50b890f36a36b51 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 30 Mar 2018 22:26:21 +0000 Subject: improved arrangement --- ports/atmel-samd/README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ports/atmel-samd/README.rst b/ports/atmel-samd/README.rst index 271187b9d..4078e7fe9 100644 --- a/ports/atmel-samd/README.rst +++ b/ports/atmel-samd/README.rst @@ -143,8 +143,7 @@ Building 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. +(``~/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: @@ -162,14 +161,15 @@ These commands should be executed from the root directory of the repository make -C mpy-cross +Build commands are run from the ``~/circuitpython/ports/atmel-samd`` directory. + To build for the Arduino Zero: .. code-block:: shell make -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: +To build for other boards you must change it by setting ``BOARD``. For example: .. code-block:: shell -- cgit v1.2.3 From 8af98d0dc95cd9b3417d938a869d3d5b39be0695 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 30 Mar 2018 22:44:16 +0000 Subject: ambiguized directory paths --- ports/atmel-samd/README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ports/atmel-samd/README.rst b/ports/atmel-samd/README.rst index 4078e7fe9..d475e3816 100644 --- a/ports/atmel-samd/README.rst +++ b/ports/atmel-samd/README.rst @@ -143,7 +143,7 @@ Building 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/``). +(``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: @@ -161,7 +161,7 @@ These commands should be executed from the root directory of the repository make -C mpy-cross -Build commands are run from the ``~/circuitpython/ports/atmel-samd`` directory. +Build commands are run from the ``circuitpython/ports/atmel-samd`` directory. To build for the Arduino Zero: -- cgit v1.2.3