qmk_firmware/keyboard/planck/README.md

Planck keyboard firmware
======================
DIY/Assembled compact ortholinear keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).

## Notable TMK forks (which some of the keymap files are from)
- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)

## Build
Move to this directory then just run `make` like:

    $ make

Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.


## Keymap
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 `keymap_<name>.c` and see keymap document(you can find in top README.md) and existent keymap files.

To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:

    $ make KEYMAP=[<name>]
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			`======================`
Update README.md 2015-01-15 18:06:43 +00:00			`DIY/Assembled compact ortholinear keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).`
added planck folder 2014-12-14 15:30:27 +00:00
Update README.md 2015-01-15 18:06:43 +00:00			`## Notable TMK forks (which some of the keymap files are from)`
			`- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)`
added planck folder 2014-12-14 15:30:27 +00:00
			`## Build`
			Move to this directory then just run `make` like:

			`$ make`

			Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.


			`## Keymap`
			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 `keymap_<name>.c` and see keymap document(you can find in top README.md) and existent keymap files.

			To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:

Update README.md 2015-01-15 18:06:43 +00:00			`$ make KEYMAP=[<name>]`