Archived
1
0
This repo is archived. You can view files and clone it, but cannot push or open issues or pull requests.
controller/Keyboards/README.markdown
2015-08-16 16:51:03 -07:00

40 lines
812 B
Markdown

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)