Skip to content

setup.md

Latest commit

 

History

History
52 lines (34 loc) · 2.38 KB

setup.md

File metadata and controls

52 lines (34 loc) · 2.38 KB

Setup

[TOC]

Installation

Required tools

The following tools are necessary to build the project

Python 3

Python 3 is used to run the waf script that controls the configuration and build process of the project

Install the latest version of python 3 for your operating system from Python.org. If you have an older version of python 3 that will probably work fine. It is recommended to select the option to add python to the path if available during the install.

ARM GNU Toolchain

The GNU arm toolchain contains the compiler and other tools necessary to build the project. To install

  1. Go to the page for the ARM GNU Toolchain Download.
  2. Download the version 13.3.Rel1 of the ARM-none-eabi toolchain for your operating system.
    1. For windows this is the .exe file.
    2. For macOS this is the .pkg file (make sure to get the correct one for if you are running an x86 or Apple Silicon Mac).
    3. For debian based linux you can run sudo apt install gcc-arm-non-eabi and skip downloading from the website.
  3. Run the installer. On windows when prompted at the end deselect all boxes except for Add to path

JLink

Segger's JLink tools are necessary to program and debug the board.

  1. Go to the page for the J-Link Downloads
  2. Download the latest version of J-Link for your operating system.
  3. Run the installer
  4. When prompted to choose a destination select Update existing install even if don't have J-Link already installed.

Git

Git is the version control platform used to keep track of the project files. Follow the installation instructions for git from the git-scm for your operating system.

Windows Specific Instructions
  1. Download the latest version of git for windows from the git-scm's download page.
  2. Run the installer
  3. When prompted to select an editor for git to use, unless you are already familiar with Vim, it is highly recommended to switch to an editor you are familiar and comfortable with.
  4. It is recommended to install the Windows Terminal App from the Microsoft Store