qmk_firmware/keyboard/planck/README.md

64 lines
3.2 KiB
Markdown
Raw Normal View History

2015-01-15 19:06:43 +01:00
Planck keyboard firmware
2014-12-14 16:30:27 +01:00
======================
2015-03-21 06:17:22 +01:00
DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
2014-12-14 16:30:27 +01:00
2015-03-21 06:17:22 +01:00
## Extended Keymap
If you include extended_keymap_common.h instead of keymap_common.h at the top of your file, you'll have access to a bunch of goodies:
- Use `LSFT()`, `LCTL()`, et. al. (listed in extended_keymap_common.h) as modifiers for keys (daisy-chain-able)
- Use `FUNC(1)` instead of `FN1` (etc.) to access the function layers beyond the 32 function layer limit
- Use `CM_F` instead of `KC_F` to get the ColeMak equivilent for shortcuts (maps backwards)
2015-03-23 05:35:05 +01:00
- Use `MACRODOWN()` instead of `MACRO()` to easily make a keydown macro (`CM_*` works here too)
2015-03-21 06:17:22 +01:00
### Some notes on usage:
- The `KEYMAP()` macro is unable to be used due to the bitwise modifications that take place - refer to extended_keymap_jack.c to see how to set things up with the `KC_` prefix
- Keep an eye on the Makefile - this needs to include the correct files to work
- Don't forget to use `const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {` instead of the 8bit equivilent
2014-12-14 16:30:27 +01:00
## Build
2015-03-18 15:19:40 +01:00
2015-04-25 00:28:03 +02:00
Follow [this guide](http://deskthority.net/workshop-f7/how-to-build-your-very-own-keyboard-firmware-t7177.html) to setup your development environment before anything else. Abbreviated instructions are provide at the [bottom of this document](https://github.com/rswiernik/tmk_keyboard/tree/rswiernik_dev/keyboard/planck#environment-setup)
2015-03-18 15:19:40 +01:00
2015-04-25 00:28:03 +02:00
Download the whole firmware [here](https://github.com/jackhumbert/tmk_keyboard/archive/master.zip) and navigate to the keyboard/planck folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex that you can load with the Teensy app onto your Planck (once you've hit reset/shorted GND & RST).
2015-03-18 15:19:40 +01:00
2015-04-25 00:28:03 +02:00
Depending on which keymap you would like to use, you will have to compile slightly differently.
2014-12-14 16:30:27 +01:00
####Default
To build the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows:
```
$ make
```
####**Extended Keymaps**
2015-04-25 00:28:03 +02:00
Extended keymaps need to be specified as follows:
```
$ make KEYMAP=[common|jack|<name>]
```
2015-04-25 00:36:57 +02:00
Applicable keymaps should follow the format **__extended\_keymap\_<name>.c__**
2015-04-25 00:28:03 +02:00
####**Common Keymaps**
2015-04-25 00:28:03 +02:00
Common keymaps need to be specified as follows:
```
$ make KEYMAP=[common|jack|<name>] COMMON=true
```
2015-04-25 00:36:57 +02:00
Applicable keymaps should follow the format **__keymap\_<name>.c__**
2015-04-25 00:28:03 +02:00
2014-12-14 16:30:27 +01:00
## Keymap
2015-03-21 06:17:22 +01: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 `keymap_<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
2014-12-14 16:30:27 +01:00
To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:
2015-01-15 19:06:43 +01:00
$ make KEYMAP=[<name>]
2015-03-21 06:17:22 +01: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)
- [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)
2015-04-25 00:28:03 +02:00
- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)
## Environment Setup