view Keyboards/README.markdown @ 362:e4be15c39cce

Adding initial WhiteFox support. - Includes fix for over-range ScanCodes (would cause hard faults) - Updated some documentation - Requires recent kll compiler for the layout
author Jacob Alexander <haata@kiibohd.com>
date Sun, 16 Aug 2015 12:27:12 -0700
parents a2df35fa4f0b
children dbe0dbd7e2dd
line wrap: on
line source

Keyboard Compiler Scripts
=========================

Scripts for major keyboards designed using the Kiibohd firmware.
Please refer to `<script> --help` for specific details.

Refer to the [wiki](https://github.com/kiibohd/controller/wiki) on setting up your system for compiling.


Build Steps
-----------

* Try to build once to make sure your system is setup correctly
* Add any .kll files in the build directory you want
* Edit `<script>` to include the new .kll files
* Rebuild


Example
-------

```bash
./infinity.bash
```


Projects
--------

* infinity.bash (Infinity Keyboard 2014/10/15)
* template.bash (Example template for new keyboards)
* whitefox.bash (Soon?)


**Extra files**

* cmake.bash (Used by the compilation script, does nothing on it's own)