aboutsummaryrefslogtreecommitdiff
path: root/keyboards/kitten_paw/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kitten_paw/readme.md')
-rw-r--r--keyboards/kitten_paw/readme.md36
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 @@
1kitten_paw keyboard firmware 1kitten_paw
2====================== 2==========
3This is the firmware for the 2016 revision of the Kitten Paw controller by Bathroom Epiphanies.
4Most of the boilerplate code is the work of [BathroomEpiphanies](https://github.com/BathroomEpiphanies).
5 3
6NKRO 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. 4This 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).
7
8## Quantum MK Firmware
9
10For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
11
12## Building
13
14Download 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.
15 5
16Depending on which keymap you would like to use, you will have to compile slightly differently. 6NKRO 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.
17
18### Default
19
20To build with the default keymap, simply run `make`.
21
22### Other Keymaps
23 7
24Several 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. 8Keyboard Maintainer: QMK Community
9Hardware Supported: Kitten Paw PCB
10Hardware Availability: https://geekhack.org/index.php?topic=46700.0
25 11
26To build the firmware binary hex file with a keymap just do `make` with `keymap` option like: 12Make example for this keyboard (after setting up your build environment):
27 13
28``` 14 make kitten_paw-default
29$ make keymap=[default|jack|<name>]
30```
31 15
32Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` 16See [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.