Keyboards/README.markdown

   1 Keyboard Compiler Scripts
   2 =========================
   3
   4 Scripts for major keyboards designed using the Kiibohd firmware.
   5 Please refer to `<script> --help` for specific details.
   6
   7 Refer to the [wiki](https://github.com/kiibohd/controller/wiki) on setting up your system for compiling.
   8
   9
  10 Build Steps
  11 -----------
  12
  13 * Try to build once to make sure your system is setup correctly
  14 * Add any .kll files in the build directory you want
  15 * Edit `<script>` to include the new .kll files
  16 * Rebuild
  17
  18
  19 Example
  20 -------
  21
  22 ```bash
  23 ./infinity.bash
  24 ```
  25
  26
  27 Projects
  28 --------
  29
  30 * infinity.bash (Infinity Keyboard 2014/10/15)
  31 * ergodox.bash  (Infinity Ergodox 2015/08/15)
  32 * template.bash (Example template for new keyboards)
  33 * whitefox.bash (Soon?)
  34
  35
  36 **Extra files**
  37
  38 * cmake.bash (Used by the compilation script, does nothing on it's own)
  39