README.markdown

   1 The Kiibohd Controller
   2 ======================
   3
   4 This is the main Kiibohd Firmware.
   5 In general, this should be the **only** git repo you need to clone.
   6 The [KLL](https://github.com/kiibohd/kll) git repo is automatically cloned during the build process.
   7
   8 Please refer to the [KLL](https://github.com/kiibohd/kll) repo or [kiibohd.com](http://kiibohd.com) for details on the KLL (Keyboard Layout Language) Spec.
   9
  10
  11
  12 Official Keyboards
  13 ------------------
  14
  15 * MD1 (Infinity Keyboard 2014/10/15)
  16
  17
  18 The Kiibohd firmware supports a lot of other keyboards, but these are more obscure/custom/lesser known.
  19
  20
  21
  22 Compilation
  23 -----------
  24
  25 Compilation is possible and tested on Windows/Linux/Mac.
  26 Linux is the easiest using this [VM](https://s3.amazonaws.com/configurator-assets/ArchLinux_kiibohd_2015-02-13.tar.gz).
  27
  28 For most people refer [here](https://github.com/kiibohd/controller/tree/master/Keyboards).
  29
  30 For the full compilation details, please refer to the [wiki](https://github.com/kiibohd/controller/wiki).
  31
  32
  33
  34 Supported Microcontrollers
  35 --------------------------
  36
  37 * Teensy 2.0 (Partial)
  38 * Teensy 2.0++
  39 * Teesny 3.0
  40 * Teensy 3.1
  41 * mk20dx128vlf5
  42 * mk20dx256vlh7
  43
  44
  45 Adding support for more microcontrollers is possible.
  46 Some considerations for minimum specs:
  47
  48 * ~8  kB of SRAM
  49 * ~25 kB of Flash
  50
  51 It's possible to port chips with lower specs, but will be more effort and have fewer features.
  52
  53
  54
  55 Contributions
  56 -------------
  57
  58 Contributions welcome!
  59
  60 * Bug reports
  61 * Documentation and Wiki editing
  62 * Patches (including new features)
  63
  64
  65
  66 Licensing
  67 ---------
  68
  69 Licensing is done on a per-file basis.
  70 Some of the source code is from [PJRC/Teensy](http://pjrc.com), other source code is from the [McHck Project](https://mchck.org).
  71 Code written specifically for the Kiibohd Controller use the following licenses:
  72
  73 * MIT
  74 * GPLv3
  75 * Public Domain
  76
  77
  78
  79 Contact
  80 -------
  81
  82 If you really need to get a hold of HaaTa, email is best: `haata@kiibohd.com`
  83
  84 IRC is likely faster though.
  85 `#geekhack@irc.freenode.net`
  86 `#deskthority@irc.freenode.net`
  87