The purpose of this project is to create a small, more capable microcontroller board. The hardware design files for this board can be found at mtrain-pcb.
Below is a quick guide to getting this mTrain project setup to build on your computer. This project only provides directions for installing on Ubuntu Linux, Windows Subsystem for Linux (WSL), and macOS.
- Clone the repository
git clone git://github.com/RoboJackets/mtrain-firmware
- Install the necessary software
There are a few setup scripts in the util directory for installing required packages, setting up udev rules, etc. See ubuntu-setup and macos-setup for more info. If you are using WSL, see wsl-setup after using ubuntu-setup.
$ cd mtrain-firmware
$ ./util/<SYSTEM>-setup
- Build the project for the desired target. The default target builds all firmware.
$ make
Firmware tests can be written and placed in tests/cpp with the name <TESTNAME>.cpp then compiled with make <TESTNAME>
We use Doxygen for documentation. This allows us to convert specially-formatted comments within code files into a nifty website that lets us easily see how things are laid out. Our compiled doxygen documentation can be found by doing:
$ make docs
For resources for beginners to embbedded development see the Getting Started Page for robocup-firmware.
For resources pertaining to the hardware of the mTrain including datasheets and schematics see the Resources Page.
This project is licensed under the Apache License v2.0. See the LICENSE file for more information