https://github.com/olical/ergodox
[DEPRECATED] My Ergodox config / tooling is now in Olical/keyboards
https://github.com/olical/ergodox
Last synced: 11 months ago
JSON representation
[DEPRECATED] My Ergodox config / tooling is now in Olical/keyboards
- Host: GitHub
- URL: https://github.com/olical/ergodox
- Owner: Olical
- License: gpl-3.0
- Created: 2016-05-06T17:02:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-25T19:19:47.000Z (almost 8 years ago)
- Last Synced: 2025-01-05T02:10:36.731Z (about 1 year ago)
- Language: C
- Homepage: https://github.com/Olical/keyboards
- Size: 3.93 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
The Kiibohd Controller
======================
This is the main Kiibohd Firmware.
In general, this should be the **only** git repo you need to clone.
The [KLL](https://github.com/kiibohd/kll) git repo is automatically cloned during the build process.
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.
[](https://travis-ci.org/kiibohd/controller) [](https://ci.appveyor.com/project/kiibohd/controller/branch/master)
[](https://kiwiirc.com/client/irc.freenode.net/#input.club)
[Visit our Discord Channel](https://discord.gg/GACJa4f)
Official Keyboards
------------------
* Infinity 60%
* Infinity 60% LED
* Infinity Ergodox
* K-Type
* WhiteFox
The Kiibohd firmware supports a lot of other keyboards, but these are more obscure/custom/lesser known.
Compilation
-----------
Compilation is possible and tested on Windows/Linux/Mac.
Linux is the easiest using this [VM](https://s3.amazonaws.com/configurator-assets/ArchLinux_kiibohd_2015-02-13.tar.gz).
For most people refer [here](https://github.com/kiibohd/controller/tree/master/Keyboards).
For the full compilation details, please refer to the [wiki](https://github.com/kiibohd/controller/wiki).
Supported Microcontrollers
--------------------------
* Teensy 2.0 (Deprecated)
* Teensy 2.0++ (Deprecated)
* Teensy 3.0
* Teensy 3.1/3.2
* mk20dx128vlf5
* mk20dx256vlh7
Adding support for more microcontrollers is possible.
Some considerations for minimum specs:
* ~8 kB of SRAM
* ~25 kB of Flash
It's possible to port chips with lower specs, but will be more effort and have fewer features.
Modules
-------
Scan <-> Macro <-> Output
* [Debug Modules](Debug) - Debug support modules (e.g. cli)
* [Scan Modules](Scan) - Defines keyboard behaviour (e.g. K-Type)
* [Macro Modules](Macro) - KLL support modules
* [Output Modules](Output) - Defines what the keyboard talks over (e.g. USB)
General Code can be found in [Lib](Lib).
Bootloader
----------
A custom bootloader (based off of [McHCK](https://github.com/mchck/mchck)) is available.
This is only necessary when assembling a keyboard with a blank MCU or if you're attempting to re-flash your bootloader (requires external tools).
[Bootloader](Bootloader)
Contributions
-------------
Contributions welcome!
* Bug reports
* Documentation and Wiki editing
* Patches (including new features)
Licensing
---------
Licensing is done on a per-file basis.
Some of the source code is from [PJRC/Teensy](http://pjrc.com), other source code is from the [McHck Project](https://mchck.org).
Code written specifically for the Kiibohd Controller use the following licenses:
* MIT
* GPLv3
* Public Domain