summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Epler <jepler@unpythonic.net>2018-03-19 21:55:49 -0500
committerJeff Epler <jepler@unpythonic.net>2018-03-20 07:53:30 -0500
commitfa491b4c327646b90de2a92ffc0c16950946f9ee (patch)
tree9b746c66605f25baf5004faef4ce239c510d7df8
parentbf42611738cd875e1bc6e278040283675599f7b8 (diff)
README.rst: spell out gcc version requirements
.. the text was adapted from ports/stm32 and a conversation with Dan Halbert.
-rw-r--r--ports/atmel-samd/README.rst18
1 files changed, 17 insertions, 1 deletions
diff --git a/ports/atmel-samd/README.rst b/ports/atmel-samd/README.rst
index 8785ccada..cd1453b01 100644
--- a/ports/atmel-samd/README.rst
+++ b/ports/atmel-samd/README.rst
@@ -115,13 +115,29 @@ PB03 **Yes** **Yes** **Yes** **Yes**
Setup
-----
-Install required compiler packages:
+
+An ARM compiler is required for the build, along with the associated binary
+utilities. On Ubuntu, these can be installed as follows:
.. code-block:: shell
sudo add-apt-repository ppa:team-gcc-arm-embedded/ppa
sudo apt-get install gcc-arm-embedded
+On Arch Linux the compiler is available for via the package
+``arm-none-eabi-gcc``.
+
+For other systems, the `GNU Arm Embedded Toolchain <https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads>`_
+may be available in binary form.
+
+The latest available package from team-gcc-arm-embedded is used to produce the
+binaries shipped by AdaFruit. Other compiler versions, particularly older
+ones, may not work properly. In particular, the ``gcc-arm-none-eabi`` package
+in Debian Stretch is too old.
+
+The compiler can be changed using the ``CROSS_COMPILE`` variable when invoking
+``make``.
+
Building
--------