diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff737e7 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +Arduino IO Interface Board for EIVE +====== + +## General Information + +This is the software for an Arduino board to set it up as an interface board. +The interface board will be used to relay commands from a host computer serial +interface to connected I2C or SPI sensors. This allows device handler testing +on a host machine. The software can either be compiled and programmed on the Arduino withmake and avrdude, provided the AVR GCC toolchain is installed, or built and flashed using +Eclipse with the Sloeber plugin. It is recommended to use Sloeber for enhanced convenience, as it takes care of the building process. It is also integrated into Eclipse, which has a powerful indexer and several other tools to ease development. + +## Instructions to build with make + +### Prerequisites + +1. When compiling on a Windows system, make sure the [Windows Development Tools](https://xpack.github.io/windows-build-tools/install/) are installed and added to the system path.This is required for make to work. + +2. Install the [AVR toolchain](https://www.microchip.com/mplab/avr-support/avr-and-arm-toolchains-c-compilers) for your OS + +3. If building the binary with make, initiate the contained arduino\_core submodule and the required core contained within that submodule by running +```sh +git submodule update --init --recursively +``` + +### Build Instructions + +1. Run following command to build the software + +```sh +make all -j +``` + +2. Run following command to clean up the directories + +```sh +make clean -j +``` + +## Instructions build with Sloeber + + + + +