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
Jacob Alexander c71e67a29a Preparing controller repo for automated travis-ci
- Added clang (i.e. multi-compiler) support to convenience build scripts
- Updated README
- Added Bootloader build scripts for the two main versions currently used
- Added uartOut and usbMuxUart build scripts (these tend to suffer from build rot the most as they're only used in debugging)
- Attempt to get clang support for the Bootloader
  * clang is missing compiler extensions, so this may require a large re-write to get working
2016-07-17 17:27:05 -07:00

41 lines
907 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)
* infinity_led.bash (Infinity Keyboard with LED backlight support)
* ergodox.bash (Infinity Ergodox 2015/08/15)
* template.bash (Example template for new keyboards)
* whitefox.bash (WhiteFox Keyboard)
**Extra files**
* cmake.bash (Used by the compilation script, does nothing on it's own)