diff --git a/README.md b/README.md index f9630e0..8fa2968 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -Arduboy -======= +Arduboy Library +=============== This library provides Arduboy's core functionality. ## Using the Library @@ -44,13 +44,21 @@ Example games and source can be found in the `examples` directory. Find and play an example by opening it through the Arduino IDE, compiling, and uploading the example to the Arduboy. Examples can be found in the Arduino IDE in the navigation menu under, `File > Examples > Arduboy > Example_Name`. +### Running on a Development Board +To run this library on a development Arduboy board, edit `src/core/core.h` so that `#define AB_DEVKIT` is uncommented and `#define ARDUBOY_10` is comment out. + +```cpp +//#define ARDUBOY_10 //< compile for the production Arduboy v1.0 +#define AB_DEVKIT //< compile for the official dev kit +``` + ### Sketches Already Including the Arduboy Library Sketches that include copies of the Arduboy library may not compile if the Arduboy library has been installed system wide. In these cases the Arduino compiler will try and link the system Arduboy library source with the local header file, which can cause compilation errors if the local library source differs from the system's Arduboy source. To compile sketches that have included copies of the Aruboy Library, -Remove the local `Arduboy.cpp` and `Arduboy.h` files and try recompiling. This will only work in some cases. - -**OR** - -Rename `Arduboy.h` to `CustomArduboy.h` (or a similar name) and add `#include "CustomArduboy.h"` to the `.ino` sketch file. +>Remove the local `Arduboy.cpp` and `Arduboy.h` files and try recompiling. This will only work in some cases. +> +>**OR** +> +>Rename `Arduboy.h` to `CustomArduboy.h` (or a similar name) and add `#include "CustomArduboy.h"` to the `.ino` sketch file.