diff options
| author |  skullY <skullydazed@gmail.com> | 2017-08-16 15:08:16 -0700 |
|---|---|---|
| committer |  Jack Humbert <jack.humb@gmail.com> | 2017-08-16 20:36:59 -0400 |
| commit | 4e73b0b8d7750bcddc445b5a52008d4c6cea977d (patch) | |
| tree | e6c54f5d0b334f1e0acc41b6406e8b26900f80b0 /keyboards/kitten_paw | |
| parent | 2ee0dc7793165eacfe7ee2a4994d557294988f18 (diff) | |
| download | qmk_firmware-4e73b0b8d7750bcddc445b5a52008d4c6cea977d.tar.gz | |
Make the bulk of our keyboards match the readme.md standard
Diffstat (limited to 'keyboards/kitten_paw')
| -rw-r--r-- | keyboards/kitten_paw/readme.md | 36 |
1 files changed, 10 insertions, 26 deletions
diff --git a/keyboards/kitten_paw/readme.md b/keyboards/kitten_paw/readme.md index a6ef2a067..55fac2ba5 100644 --- a/keyboards/kitten_paw/readme.md +++ b/keyboards/kitten_paw/readme.md @@ -1,32 +1,16 @@ -kitten_paw keyboard firmware -====================== -This is the firmware for the 2016 revision of the Kitten Paw controller by Bathroom Epiphanies. -Most of the boilerplate code is the work of [BathroomEpiphanies](https://github.com/BathroomEpiphanies). +kitten_paw +========== -NKRO doesn't work at the moment, I don't know if I will take the time to find out how to fix this, so far 6KRO is enough for me. - -## Quantum MK Firmware - -For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). - -## Building - -Download or clone the whole firmware and navigate to the keyboards/kitten_paw 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. +This is the firmware for the 2016 revision of the Kitten Paw controller by Bathroom Epiphanies. Most of the boilerplate code is the work of [BathroomEpiphanies](https://github.com/BathroomEpiphanies). -Depending on which keymap you would like to use, you will have to compile slightly differently. - -### Default - -To build with the default keymap, simply run `make`. - -### Other Keymaps +NKRO doesn't work at the moment, I don't know if I will take the time to find out how to fix this, so far 6KRO is enough for me. -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. +Keyboard Maintainer: QMK Community +Hardware Supported: Kitten Paw PCB +Hardware Availability: https://geekhack.org/index.php?topic=46700.0 -To build the firmware binary hex file with a keymap just do `make` with `keymap` option like: +Make example for this keyboard (after setting up your build environment): -``` -$ make keymap=[default|jack|<name>] -``` + make kitten_paw-default -Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` +See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. |