skullY d561f63bd1 | 7 years ago | |
---|---|---|
.. | ||
keymaps | 7 years ago | |
rev1 | 8 years ago | |
rev2 | 7 years ago | |
Makefile | 7 years ago | |
clueboard.c | 8 years ago | |
clueboard.h | 8 years ago | |
config.h | 7 years ago | |
readme.md | 7 years ago |
DIY/Assembled compact 66% keyboard by Clueboard.
For the full Quantum Mechanical Keyboard feature list, see the parent readme.md.
Download or clone the whole firmware and navigate to the keyboards/clueboard directory. Once your dev env is setup, you'll be able to generate the default .hex:
$ make
You will see a lot of output and if everything worked correctly you will see something similar to this:
Size after:
text data bss dec hex filename
0 19992 0 19992 4e18 clueboard_rev2_default.hex
At this point you can press RESET on your Clueboard and flash your keyboard with this command:
$ make dfu
If you would like to use one of the alternative keymaps, or create your own, see below.
If you have a first generation Clueboard (one with a black PCB) you will need to use the revision 1 code. To do so add SUBPROJECT=rev1
to your make command, like this:
$ make SUBPROJECT=rev1
And when flashing your keyboard:
$ make SUBPROJECT=rev1 dfu
If you are flashing an alternative layout to your rev1, include both SUBPROJECT=rev1
and KEYMAP=<keymap>
in your command, for example when flashing max:
$ make SUBPROJECT=rev1 KEYMAP=max dfu
There are many alternative and user-contributed layouts available in the keymaps/ directory. To compile and flash an alternative you will want to add KEYMAP=<keymap>
to your command:
$ make KEYMAP=skully
And when flashing your keyboard, put KEYMAP=<keymap>
between "make" and "dfu":
$ make KEYMAP=skully dfu
These layouts are notable for one reason or another. If you are looking for ideas or inspiration you should look at these first:
There are a lot of possibilities when creating your own keymap, and the primary documentation for doing that is Customizing Your Keymap in the main readme.md. As a way to get started, here is the procedure I recommend:
[keymaps/default](keymaps/default/)
to keymaps/<your_layout>
.$ make KEYMAP=<your_layout>
)$ make KEYMAP=<your_layout> dfu
)keymaps/<your_layout>/readme.md
to tell others about your layout.keymaps/<your_layout>/keymap.c
to reflect your desired layout.$ make KEYMAP=<your_layout>
)
** If you have warnings you may flash without fixing them, but something may not work right.
** If you have any errors you must fix them before continuing.$ make KEYMAP=<your_layout> dfu
)Got your layout dialed in? Please share it with the world so we can benefit from your work! Simply submit a pull request with your layout and we'll include it in the official repository. Please use the following guidelines when putting together your pull request:
TODO: Write up or link quick how-to on creating and submitting a PR. (Pull requests accepted. :)