2cf26915e3
* More documentation * Saving crontab for user on host * Restructuring in keeping with recent changes to conventions * Simplify submitting my fave cbbrowne keystroke by using SEND_STRING() * Local change, not apropos to have in this repo * Simplify logic; no need to return so much * Add in a version key * Add docs * Split build date into a separate DEFINE * Ensure there is a value even if not working within a git repo * Should not include the compiled code in the repo * compiled.hex files should not be included in the repo; they represent generated compiled code * Fix spelling in comment * Remove more generated files * Add rule to ignore contents of .build directories; their contents are generated * Revert removals of compiled files |
9 years ago | |
---|---|---|
.. | ||
keymaps | 9 years ago | |
old_keymap_files | 9 years ago | |
.gitignore | 9 years ago | |
Makefile | 9 years ago | |
README.md | 9 years ago | |
config.h | 9 years ago | |
planck.c | 9 years ago | |
planck.h | 9 years ago | |
planck_pcb_r3.hex | 9 years ago | |
planck_pcb_r3_w_bootloader.hex | 9 years ago | |
planck_pcb_r4.hex | 9 years ago | |
planck_pcb_r4_w_bootloader.hex | 9 years ago |
README.md
Planck keyboard firmware
DIY/Assembled compact ortholinear 40% keyboard by Ortholinear Keyboards.
Quantum MK Firmware
For the full Quantum feature list, see the parent README.md.
Building
Download or clone the whole firmware and navigate to the keyboard/planck folder. Once your dev env is setup, you'll be able to type make
to generate your .hex - you can then use make dfu
to program your PCB once you hit the reset button.
Depending on which keymap you would like to use, you will have to compile slightly differently.
Default
To build with the default keymap, simply run make
.
Other Keymaps
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named <name>.c
in the keymaps folder, and see keymap document (you can find in top README.md) and existent keymap files.
To build the firmware binary hex file with a keymap just do make
with KEYMAP
option like:
$ make KEYMAP=[default|jack|<name>]
Keymaps follow the format <name>.c and are stored in the keymaps
folder.