summaryrefslogtreecommitdiff
path: root/keyboards/kc60/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2020-04-15 13:31:09 -0700
committerGitHub <noreply@github.com>2020-04-15 22:31:09 +0200
commit3cc68543ca8c69048ffc0655d92be238afcee376 (patch)
tree93a3e3208c8980c68ad50ea36de50e63f8974456 /keyboards/kc60/readme.md
parentdaf6dedb02d96af789deccc2f96fe281486207c0 (diff)
downloadqmk_firmware-3cc68543ca8c69048ffc0655d92be238afcee376.tar.gz
qmk_firmware-3cc68543ca8c69048ffc0655d92be238afcee376.zip
KC60 Refactor (#8782)
Diffstat (limited to 'keyboards/kc60/readme.md')
-rw-r--r--keyboards/kc60/readme.md38
1 files changed, 11 insertions, 27 deletions
diff --git a/keyboards/kc60/readme.md b/keyboards/kc60/readme.md
index e152824ccf..71888e7503 100644
--- a/keyboards/kc60/readme.md
+++ b/keyboards/kc60/readme.md
@@ -1,35 +1,19 @@
-KC60 (version 2.0) keyboard firmware
-======================
+# KC60
-## Quantum MK Firmware
-For the full Quantum feature list, see [the parent readme.md](/readme.md).
+![KC60](https://raw.githubusercontent.com/noroadsleft/qmk_images/master/keyboards/kc60/kc60.jpg)
-## Building
-Download or clone the whole firmware and navigate to the keyboards/kc60 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.
+A 60% PCB supporting in-switch LEDs, formerly available on AliExpress and (Mass)Drop. Supports ANSI, ISO, split Backspace, and both standard and Tsangan bottom row layouts.
-Depending on which keymap you would like to use, you will have to compile slightly differently.
+* Keyboard Maintainer: [The QMK Community](https://github.com/qmk)
+* Hardware Supported: KC60 v1.6, v2.0; ATmega32U4
+* Hardware Availability: [Drop.com](https://drop.com/buy/kc60-mechanical-keyboard?mode=guest_open) (no longer available)
-### Default
-To build with the default keymap, simply run `make default`.
+Make example for this keyboard (after setting up your build environment):
-### 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 file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top readme.md) and existent keymap files.
+ make kc60:default
-To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
+## RGB Underglow Support
-```
-$ make [default|jack|<name>]
-```
+To add RGB Underglow to the KC60, see [Adding RGB Underglow to the KC60](mod_rgb_underglow.md).
-Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
-
-## WS2812 Support
-
-Build with WS2812 Support by running `make ws2812`.
-
-## Warning
-For those who want to use 2x1U instead of classic backspace you need to use K0D and K49 like this:
-* K0D represents the key at the right of =.
-* K49 represents the last key of the row (is wired at the right of the space key on the PCB)
-
-In kc60.h I've put several definitions' examples of possible layouts proposed by online editor (http://123.57.250.164:9128/).
+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).