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