Kiibohd Controller
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

README.markdown 2.1KB

8 vuotta sitten
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. The Kiibohd Controller
  2. ======================
  3. This is the main Kiibohd Firmware.
  4. In general, this should be the **only** git repo you need to clone.
  5. The [KLL](https://github.com/kiibohd/kll) git repo is automatically cloned during the build process.
  6. 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.
  7. Official Keyboards
  8. ------------------
  9. * MD1 (Infinity Keyboard/IC60 2014/10/15)
  10. * MDErgo1 (Infinity Ergodox /ICED 2015/03/31)
  11. * WhiteFox (Soon to be released?)
  12. The Kiibohd firmware supports a lot of other keyboards, but these are more obscure/custom/lesser known.
  13. Compilation
  14. -----------
  15. Compilation is possible and tested on Windows/Linux/Mac.
  16. Linux is the easiest using this [VM](https://s3.amazonaws.com/configurator-assets/ArchLinux_kiibohd_2015-02-13.tar.gz).
  17. For most people refer [here](https://github.com/kiibohd/controller/tree/master/Keyboards).
  18. For the full compilation details, please refer to the [wiki](https://github.com/kiibohd/controller/wiki).
  19. Supported Microcontrollers
  20. --------------------------
  21. * Teensy 2.0 (Partial)
  22. * Teensy 2.0++
  23. * Teensy 3.0
  24. * Teensy 3.1/3.2
  25. * mk20dx128vlf5
  26. * mk20dx256vlh7
  27. Adding support for more microcontrollers is possible.
  28. Some considerations for minimum specs:
  29. * ~8 kB of SRAM
  30. * ~25 kB of Flash
  31. It's possible to port chips with lower specs, but will be more effort and have fewer features.
  32. Contributions
  33. -------------
  34. Contributions welcome!
  35. * Bug reports
  36. * Documentation and Wiki editing
  37. * Patches (including new features)
  38. Licensing
  39. ---------
  40. Licensing is done on a per-file basis.
  41. Some of the source code is from [PJRC/Teensy](http://pjrc.com), other source code is from the [McHck Project](https://mchck.org).
  42. Code written specifically for the Kiibohd Controller use the following licenses:
  43. * MIT
  44. * GPLv3
  45. * Public Domain
  46. Contact
  47. -------
  48. If you really need to get a hold of HaaTa, email is best: `[email protected]`
  49. IRC is likely faster though.
  50. `#[email protected]`
  51. `#[email protected]`
  52. `#[email protected]`