git.zerfleddert.de Git - fnordlicht-mini/blob - firmware/README

   1 fnordlicht and fnordlichtmini firmware
   2 ======================================
   3
   4 This is the firmware sourcecode for different hardware devices, namely:
   5 * fnordlicht            (for details see [1])
   6 * fnordlichtmini        (for details see [2])
   7 * fnordlicht-controller (for details see [3])
   8
   9 Directory layout
  10 ================
  11
  12 This repository consists of several different subdirectories:
  13
  14 bugs/                               files for the ditz[3] issue tracking system
  15 doc/                                further documentation and serial protocol description
  16 fnordlicht-firmware/                firmware sourcecode for fnordlicht and fnordlichtmini
  17 fnordlicht-bootloader/              serial bootloader for fnordlicht and fnordlichtmini
  18 fnordlicht-controller/              firmware sourcecode for fnordlicht-controller
  19 fnordlicht-controller-bootloader/   sourcecode for the fnordlicht-controller usb bootloader
  20 common/                             common C header files used by all programs
  21 tests/                              ruby-scripts for testing the serial
  22                                     protocol implementation
  23 compiled/                           compiled binaries for several processors
  24
  25
  26 git submodules
  27 ==============
  28
  29 If the directory 'fnordlicht-controller-bootloader' does not contain any files
  30 (and you cloned the repository with git), you need to initialize the submodule:
  31 $ git submodule init
  32 [...]
  33 $ git submodule update
  34 [...]
  35
  36 License
  37 =======
  38
  39 Each file contains a header, which states the author(s) and license for that
  40 file.  Most code is licensed as GPL (version 3).  The text for this license can
  41 be found in the file COPYING.
  42
  43 Links
  44 =====
  45
  46 [1] http://www.lochraster.org/fnordlicht
  47 [2] http://www.lochraster.org/fnordlichtmini
  48 [3] http://ditz.rubyforge.org