Skip to content

Building From Source

Wray Bowling edited this page Sep 14, 2020 · 4 revisions

Step 1: Get The Source Code

First, you need to download the source code. There are multiple ways to do this.

The GUI way

I personally prefer using Sourcetree which makes it very easy to switch between branches. If you're new to git, this is a great way to get your feet wet.

The command-line way

I assume that if you're here, you already understand git. You're mostly on your own, buddy. In case you don't understand git, here's a guide to git for beginners

  1. Pull down the source git clone https://github.com/MicroWrave/tri-plus-ger.git
  2. Open the tri-plus-ger/ folder in your editor
  3. Optionally, check out the appropriate branch. For example this unstable alpha git checkout tags/v0.2

Step 2: Install PlatformIO Extension

Tri+ger source code can be easily built and uploaded to the module within your text editor using an extension called PlatformIO. The editor extension method is recommended.

The GUI way

PlatformIO can be installed on top of many text editors and IDEs Simply add the platformio extension for Mac, Linux, or Windows. Follow installation instructions for your own operating system, environment, editor combo.

The command-line way

In a commend-line only environment install platformio command-line application, and two vim addons with vundle, neomake and neomake-platformio.

Step 3: Build & Upload

How you build will depend on which environment you've set up. You can choose an environment that matches the programmer you're using to shorten the build time. Many common programmers were added to make uploading quick and easy for a variety of hardware. Read more about programmers on the platformIO website.

The GUI way

Select the PlatformIO tab from the sidebar and click either

  • Build to build the code
  • Upload to build and then upload to the Tri-ger using a programmer.

The command-line way

First run platformio run navigate to the tri-plus-ger/ folder and run either

  • platformio build
  • platformio upload