Arduboy Documentation

Installation Guide

These instructions are largely the same as the official ones.

Setup instructions for Arduino IDE

  1. Download and install the Arduino IDE for your OS
  2. Install the Arduboy library:
    1. Launch the Arduino IDE
    2. Click the menu item "Manage Libraries" (Sketch > Include Library > Manage Libraries...)
    3. Search for Arduboy and select it
    4. Select Version 1.1.0
    5. Click the install button

Now you can just select Sketch > Include Library > Arduboy for new programs.

Your development environment is ready to go. Next: "Hello World" tutorial.

Setup for those who want to use Git

This approach is largely for those who want to work on the core library or their own libraries. The above approach will keep you up to date better more easily.

  1. Download and install the Arduino IDE for your OS
  2. Install Git (skip if you already have it)
  3. Find the location of your library folder:
    • Linux: /home/username/Documents/Arduino/libraries
    • OS X: /Users/username/Documents/Arduino/libraries
    • Windows: C:\Users\username\My Documents\Arduino\libraries
  4. Check out the repository into the folder found in the last step:
    1. git clone https://github.com/Arduboy/Arduboy.git
    2. cd Arduboy
    3. git checkout tags/v1.1

    If you're not using a command-line version of Git, the above steps will be different. If you want to use a more up to date version of the library that could have broken stuff, just use the master branch. (They don't recommend this, though.)

Now you can just select Sketch > Include Library > Arduboy for new programs.

Your development environment is ready to go. Next: "Hello World" tutorial.