diff options
Diffstat (limited to 'keyboards/handwired/woodpad/readme.md')
| -rw-r--r-- | keyboards/handwired/woodpad/readme.md | 31 |
1 files changed, 10 insertions, 21 deletions
diff --git a/keyboards/handwired/woodpad/readme.md b/keyboards/handwired/woodpad/readme.md index 2697398c9..189e6c4ad 100644 --- a/keyboards/handwired/woodpad/readme.md +++ b/keyboards/handwired/woodpad/readme.md | |||
| @@ -1,28 +1,17 @@ | |||
| 1 | woodpad keyboard firmware | 1 | # Woodpad |
| 2 | ====================== | ||
| 3 | 2 | ||
| 4 | ## Quantum MK Firmware | 3 |  |
| 5 | 4 | ||
| 6 | For the full Quantum feature list, see [the parent readme](/). | 5 | * Keyboard Maintainer: QMK Community |
| 6 | * Hardware Supported: Woodpad PCB | ||
| 7 | * Hardware Availability: [WoodKeys](https://woodkeys.click/product/woodpad/) | ||
| 7 | 8 | ||
| 8 | ## Building | 9 | Make example for this keyboard (after setting up your build environment): |
| 9 | 10 | ||
| 10 | Download or clone the whole firmware and navigate to the keyboards/woodpad folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. | 11 | make handwired/woodpad:default |
| 11 | 12 | ||
| 12 | Depending on which keymap you would like to use, you will have to compile slightly differently. | 13 | Flashing example for this keyboard: |
| 13 | 14 | ||
| 14 | ### Default | 15 | make handwired/woodpad:default:flash |
| 15 | 16 | ||
| 16 | To build with the default keymap, simply run `make default`. | 17 | See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). |
| 17 | |||
| 18 | ### Other Keymaps | ||
| 19 | |||
| 20 | Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files. | ||
| 21 | |||
| 22 | To build the firmware binary hex file with a keymap just do `make` with a keymap like this: | ||
| 23 | |||
| 24 | ``` | ||
| 25 | $ make [default|jack|<name>] | ||
| 26 | ``` | ||
| 27 | |||
| 28 | Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. | ||
