view Keyboards/README.markdown @ 431:7bc4c6249dff

Move matrix information to a cli command
author Jacob Alexander <haata@kiibohd.com>
date Tue, 22 Mar 2016 19:51:43 -0700
parents dbe0dbd7e2dd
children
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)
* ergodox.bash  (Infinity Ergodox 2015/08/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)