Skip to content
This repository was archived by the owner on Mar 16, 2024. It is now read-only.

Setup

Jump to bottom
Austin Keener edited this page Jul 26, 2020 · 4 revisions

This guide explains all of the steps needed to setup your computer for developing mJacket API based firmware.

Contents

Project Setup

Automated Setup

  1. First, clone the mJackets API to your computer using git clone https://github.com/RoboJackets/mjackets-api.git in your command terminal.
  2. Open the freshly cloned mjackets-api reposity and run the top-level install script. This script will setup a template project. The script will ask you to specify where you want your project template to be installed to.
    • For windows: ./install.batch
    • For linux: ./install.bash

Manual setup

If you do not want to use the install script, you can setup your project manually using the following steps:

  1. Clone this repository using git clone https://github.com/RoboJackets/mjackets-api.git
  2. Copy the contents of the TEMPLATE directory into your project directory.
  3. If a git project has not already been set up in your project directory, use git init to initialize an empty git project.
  4. In your project directory, run git submodule init && git submodule update to download the mJackets API to your project.
  5. Inside of the mjackets-api directory, run git submodule init && git submodule update again to download all of the API's submodules.

Development Environment Setup

In order to generate a build system and compile firmware, you need several packages on your computer including the ARM toolchain, git, and CMake. Follow the below instructions to setup these packages on your computer.

Windows

Automated Setup

Run the windows-setup.batch script in the UTIL directory to install the required dependencies.

Manual Setup

Linux/OSX

Automated Setup

Run the appropriate setup script from the UTIL directory for your operating system to install the required dependencies.

  • Ubuntu - ubuntu-setup.sh
  • OSX - osx-setup.sh

Manual Setup

Ubuntu

Download all the nessesary packages using:

For Ubuntu < 20.04LTS
apt-get update && apt-get install ccache doxygen git clang-format-3.9 python3-pip python3-setuptools gcc-arm-none-eabi

You will need to install CMake manually as the minimum required version of CMake (3.14) for the mJackets API is not available for Ubuntu versions less than 20.04LTS through the apt repos. You can download the binaries from https://cmake.org/download/ and then follow the instructions in https://cmake.org/install/ to install the program. Check to make sure CMake is available from PATH using cmake --version in the command terminal.

For Ubuntu >= 20.04LTS
apt-get update && apt-get install cmake ccache doxygen git clang-format-3.9 python3-pip python3-setuptools gcc-arm-none-eabi

Clone this wiki locally