Mercurial > louis > kiibohd-controller
annotate 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 |
rev | line source |
---|---|
312
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
1 Keyboard Compiler Scripts |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
2 ========================= |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
3 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
4 Scripts for major keyboards designed using the Kiibohd firmware. |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
5 Please refer to `<script> --help` for specific details. |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
6 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
7 Refer to the [wiki](https://github.com/kiibohd/controller/wiki) on setting up your system for compiling. |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
8 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
9 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
10 Build Steps |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
11 ----------- |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
12 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
13 * Try to build once to make sure your system is setup correctly |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
14 * Add any .kll files in the build directory you want |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
15 * Edit `<script>` to include the new .kll files |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
16 * Rebuild |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
17 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
18 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
19 Example |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
20 ------- |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
21 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
22 ```bash |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
23 ./infinity.bash |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
24 ``` |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
25 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
26 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
27 Projects |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
28 -------- |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
29 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
30 * infinity.bash (Infinity Keyboard 2014/10/15) |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
31 * template.bash (Example template for new keyboards) |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
32 |
c5f083de1838
Adding convenience compiler scripts.
Jacob Alexander <haata@kiibohd.com>
parents:
diff
changeset
|
33 |
313
a2df35fa4f0b
Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents:
312
diff
changeset
|
34 **Extra files** |
a2df35fa4f0b
Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents:
312
diff
changeset
|
35 |
a2df35fa4f0b
Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents:
312
diff
changeset
|
36 * cmake.bash (Used by the compilation script, does nothing on it's own) |
a2df35fa4f0b
Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents:
312
diff
changeset
|
37 |