diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2016-06-24 04:18:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-06-24 04:18:20 +0200 |
| commit | 13bb6b4b7fdd2b3e419d0f89c93fb980b00eeb9b (patch) | |
| tree | 2777e5c95bad3f5a9773fc58524a6ad99df63738 /keyboards/planck/readme.md | |
| parent | ba116ceb496011bb35ce074a3ba8c2448f059260 (diff) | |
| download | qmk_firmware-13bb6b4b7fdd2b3e419d0f89c93fb980b00eeb9b.tar.gz qmk_firmware-13bb6b4b7fdd2b3e419d0f89c93fb980b00eeb9b.tar.xz | |
Backlight abstraction and other changes (#439)
* redoes matrix pins, abstracts backlight code for B5,6,7
* slimming down keyboard stuff, backlight breathing implemented
* don't call backlight init when no pin
* cleans up user/kb/quantum calls, keyboard files
* fix pvc atomic
* replaces CHANNEL with correct var in breathing
* removes .hexs, updates readmes, updates template
* cleans-up clueboards, readmes to lowercase
* updates readme
Diffstat (limited to 'keyboards/planck/readme.md')
| -rw-r--r-- | keyboards/planck/readme.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/planck/readme.md b/keyboards/planck/readme.md new file mode 100644 index 000000000..f89fdeb93 --- /dev/null +++ b/keyboards/planck/readme.md @@ -0,0 +1,31 @@ +Planck keyboard firmware +====================== +DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent readme.md](/readme.md). + +## Building + +Download or clone the whole firmware and navigate to the keyboards/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. + +### Notable forks (which some of the keymap files are from) +- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck) +- [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c) +- [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck) +- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid) |