qmk_firmware/keyboards/planck/readme.md

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 default`.

### 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 a keymap like this:

```
$ make [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)
Update README.md 2015-01-15 18:06:43 +00:00			`Planck keyboard firmware`
added planck folder 2014-12-14 15:30:27 +00:00			`======================`
updated readme 2015-03-21 05:17:22 +00:00			`DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).`
added planck folder 2014-12-14 15:30:27 +00:00
READMEs 2015-10-27 04:48:22 +00:00			`## Quantum MK Firmware`
new keymap folder structure and makefile magic 2016-01-16 05:51:24 +00:00
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 2016-06-24 02:18:20 +00:00			`For the full Quantum feature list, see [the parent readme.md](/readme.md).`
readmes\! 2015-10-29 22:37:29 +00:00
			`## Building`

Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432) * fixes from tmk's repo * rename keyboard to keyboards 2016-06-22 02:39:54 +00:00			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.
Update README.md 2015-03-18 14:19:40 +00:00
Updated readme with new build info 2015-04-24 22:28:03 +00:00			`Depending on which keymap you would like to use, you will have to compile slightly differently.`
added planck folder 2014-12-14 15:30:27 +00:00
readmes\! 2015-10-29 22:37:29 +00:00			`### Default`
Update keyboard readme files with new makefile instructions 2016-08-20 00:22:16 +00:00			To build with the default keymap, simply run `make default`.
Update README.md Updated formatting again... 2015-04-24 22:35:57 +00:00
readmes\! 2015-10-29 22:37:29 +00:00			`### Other Keymaps`
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 2016-06-24 02:18:20 +00:00			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.
Update README.md Changed formatting mistake 2015-04-24 22:29:50 +00:00
Update keyboard readme files with new makefile instructions 2016-08-20 00:22:16 +00:00			To build the firmware binary hex file with a keymap just do `make` with a keymap like this:

Updated readme with new build info 2015-04-24 22:28:03 +00:00			```
Update keyboard readme files with new makefile instructions 2016-08-20 00:22:16 +00:00			`$ make [default\|jack\|<name>]`
Updated readme with new build info 2015-04-24 22:28:03 +00:00			```
Update keyboard readme files with new makefile instructions 2016-08-20 00:22:16 +00:00
Updated several keyboard folders to use new keymap naming scheme 2016-03-30 01:53:36 +00:00			Keymaps follow the format __\<name\>.c__ and are stored in the `keymaps` folder.
updated readme 2015-03-21 05:17:22 +00:00
readmes\! 2015-10-29 22:37:29 +00:00			`### Notable forks (which some of the keymap files are from)`
updated readme 2015-03-21 05:17:22 +00:00			`- [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)`
Updated readme with new build info 2015-04-24 22:28:03 +00:00			`- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)`