README

fnordlicht and fnordlichtmini firmware
======================================

This is the firmware sourcecode for different hardware devices, namely:
* fnordlicht            (for details see [1])
* fnordlichtmini        (for details see [2])
* fnordlicht-controller (for details see [3])

Directory layout
================

This repository consists of several different subdirectories:

bugs/                               files for the ditz[3] issue tracking system
doc/                                further documentation and serial protocol description
fnordlicht-firmware/                firmware sourcecode for fnordlicht and fnordlichtmini
fnordlicht-bootloader/              serial bootloader for fnordlicht and fnordlichtmini
fnordlicht-controller/              firmware sourcecode for fnordlicht-controller
fnordlicht-controller-bootloader/   sourcecode for the fnordlicht-controller usb bootloader
common/                             common C header files used by all programs
tests/                              ruby-scripts for testing the serial
                                    protocol implementation
compiled/                           compiled binaries for several processors


git submodules
==============

If the directory 'fnordlicht-controller-bootloader' does not contain any files
(and you cloned the repository with git), you need to initialize the submodule:
$ git submodule init
[...]
$ git submodule update
[...]

License
=======

Each file contains a header, which states the author(s) and license for that
file.  Most code is licensed as GPL (version 3).  The text for this license can
be found in the file COPYING.

Links
=====

[1] http://www.lochraster.org/fnordlicht
[2] http://www.lochraster.org/fnordlichtmini
[3] http://ditz.rubyforge.org