AMiRo-Apps is a collection of applications and configurations for the Autonomous
Mini Robot (AMiRo) [1]. It is tightly coupled to the AMiRo-OS and uRtWare
projects, which provide a sophisticated operating system (based on ChibiOS) amd
a real-time middleware for embedded devices.

Copyright (C) 2018..2018  Thomas Schöpping et al.
(a complete list of all authors is given below)

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

This research/work was supported by the Cluster of Excellence
Cognitive Interaction Technology 'CITEC' (EXC 277) at Bielefeld
University, which is funded by the German Research Foundation (DFG).

Authors:
 - Thomas Schöpping          <tschoepp[at]cit-ec.uni-bielefeld.de>
 - Marc Rothmann

References:
 [1] S. Herbrechtsmeier, T. Korthals, T. Schopping and U. Rückert, "AMiRo: A
     modular & customizable open-source mini robot platform," 2016 20th
     International Conference on System Theory, Control and Computing (ICSTCC),
     Sinaia, 2016, pp. 687-692.



################################################################################
#                                                                              #
#        RRRRRRRR   EEEEEEEE     AAA     DDDDDDDD   MM     MM  EEEEEEEE        #
#        RR     RR  EE          AA AA    DD     DD  MMM   MMM  EE              #
#        RR     RR  EE         AA   AA   DD     DD  MMMM MMMM  EE              #
#        RRRRRRRR   EEEEEE    AA     AA  DD     DD  MM MMM MM  EEEEEE          #
#        RR   RR    EE        AAAAAAAAA  DD     DD  MM     MM  EE              #
#        RR    RR   EE        AA     AA  DD     DD  MM     MM  EE              #
#        RR     RR  EEEEEEEE  AA     AA  DDDDDDDD   MM     MM  EEEEEEEE        #
#                                                                              #
################################################################################

This file will help you to setup all required software on your system, compile
the source code, and flash it to the AMiRo modules.

================================================================================

CONTENTS:

  1  Required software
  3  Building and flashing

================================================================================



1 - REQUIRED SOFTWARE
---------------------

Since AMiRo-Apps depends on the AMiRo-OS and uRtWare projects, both are included
as Git submodules. Use the provided ./setup.sh script to initialize those. When
AMiRo-OS is fully configured, there is no additional software required by
AMiRo-Apps. For further details about the initialization follow the instructions
in the script and refer to the README.txt file of AMiRo-OS and uRtWare
respectively.



2 - BUILDING AND FLASHING
-------------------------

For building and flashing a specific setup, you must first define a
configuration in the ./configurations folder (e.g. ./configurations/MyConf).
Such a configuration must consist of a Makefile and a C header file with the
name "osconf.h". Please copy the provided template files from the
./configurations/template directory and modify them as required in order to
minimize the risk of errors and for the sake of consistency. As a result you can
build and flash all software using the Makefile.

================================================================================