view Keyboards/README.markdown @ 313:a2df35fa4f0b

Updating the README to be of a more reasonable length.
author Jacob Alexander <haata@kiibohd.com>
date Sun, 15 Mar 2015 21:37:57 -0700
parents c5f083de1838
children e4be15c39cce
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)


**Extra files**

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