diff options
| author | cr3473 <joe@createtank.com> | 2015-06-02 13:58:45 -0700 |
|---|---|---|
| committer | cr3473 <joe@createtank.com> | 2015-06-02 13:58:45 -0700 |
| commit | bcb04570eaf80d3eeb89d79dec9336b47d65d622 (patch) | |
| tree | 6e0143d7e556fe174e096dbd46f748360ebe6018 /keyboard/planck/PCB_GUIDE.md | |
| parent | cea51941a469d85ed21a209526e493f67c853f3d (diff) | |
| download | qmk_firmware-bcb04570eaf80d3eeb89d79dec9336b47d65d622.tar.gz qmk_firmware-bcb04570eaf80d3eeb89d79dec9336b47d65d622.zip | |
PCB Guide edits and update to joe's keymap
Diffstat (limited to 'keyboard/planck/PCB_GUIDE.md')
| -rw-r--r-- | keyboard/planck/PCB_GUIDE.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/keyboard/planck/PCB_GUIDE.md b/keyboard/planck/PCB_GUIDE.md index f757407463..efe960abbf 100644 --- a/keyboard/planck/PCB_GUIDE.md +++ b/keyboard/planck/PCB_GUIDE.md @@ -22,12 +22,13 @@ ## Using the built-in functions -Here is a list of some of the functions avaiable from the command line: +Here is a list of some of the functions available from the command line: * `make clean`: clean the environment - may be required in-between builds * `make`: compile the code * `make COMMON=true`: compile with the common (non-extended) keymap -* `make KEYMAP=<keymap>`: compile with the extended keymap file `extended_keymaps_extended_keymap_<keymap>.c` +* `make MATRIX=<matrix_file>`: compile with the referenced matrix file. Default if unspecified is `matrix_pcb.c`. For handwired boards, use `matrix_handwired.c`. +* `make KEYMAP=<keymap>`: compile with the extended keymap file `extended_keymaps/extended_keymap_<keymap>.c` * `make COMMON=true KEYMAP=<keymap>`: compile with the common keymap file `common_keymaps/keymap_<keymap>.c` * `make dfu`: build and flash the layout to the PCB * `make dfu-force`: build and force-flash the layout to the PCB (may be require for first flash) @@ -81,7 +82,7 @@ A number of other keycodes have been added that you may find useful: ### Function layers -The extended keymap extends the number of function layers from 32 to the near-infinite value of 256. Rather than using `FN<num>` notation (still avaiable, but limited to `FN0`-`FN31`), you can use the `FUNC(<num>)` notation. `F(<num>)` is a shortcut for this. +The extended keymap extends the number of function layers from 32 to the near-infinite value of 256. Rather than using `FN<num>` notation (still available, but limited to `FN0`-`FN31`), you can use the `FUNC(<num>)` notation. `F(<num>)` is a shortcut for this. The function actions are unchanged, and you can see the full list of them [here](https://github.com/jackhumbert/tmk_keyboard/blob/master/common/action_code.h). They are explained in detail [here](https://github.com/jackhumbert/tmk_keyboard/blob/master/doc/keymap.md#2-action). |