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 2697398c96..189e6c4ade 100644 --- a/keyboards/handwired/woodpad/readme.md +++ b/keyboards/handwired/woodpad/readme.md @@ -1,28 +1,17 @@ -woodpad keyboard firmware -====================== +# Woodpad -## Quantum MK Firmware + -For the full Quantum feature list, see [the parent readme](/). +* Keyboard Maintainer: QMK Community +* Hardware Supported: Woodpad PCB +* Hardware Availability: [WoodKeys](https://woodkeys.click/product/woodpad/) -## Building +Make example for this keyboard (after setting up your build environment): -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. + make handwired/woodpad:default -Depending on which keymap you would like to use, you will have to compile slightly differently. +Flashing example for this keyboard: -### Default + make handwired/woodpad:default:flash -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 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. - -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. +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). |