summaryrefslogtreecommitdiff
path: root/keyboards/cospad/readme.md
diff options
context:
space:
mode:
authorkamisamamizu2017-12-17 17:44:13 +0100
committerJack Humbert2017-12-17 11:44:13 -0500
commit12e66330c5fad6dccc1e7be34f68f2db200b9f6e (patch)
tree4d8856f6e48b699ac8bef1c401d997fb884f7328 /keyboards/cospad/readme.md
parentd91c9858c56d23c3197ced87c113b011562cdf8e (diff)
Add COSPAD to QMK and add functions to read HSV (#2156)
* Added functions to read HSV values I have added three functions to rgb_light.c to be able to read the hue, saturation and value from other places. They are rgblight_get_hue(), rgblight_get_sat(), adn rgblight_get_val(). * Create keymap.c * Add COSPAD support to QMK I have ported the COSPAD numpad to qmk. * Update readme.md * Update cospad.c
Diffstat (limited to 'keyboards/cospad/readme.md')
-rw-r--r--keyboards/cospad/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/cospad/readme.md b/keyboards/cospad/readme.md
new file mode 100644
index 000000000..436b87dce
--- /dev/null
+++ b/keyboards/cospad/readme.md
@@ -0,0 +1,21 @@
+COSPAD
+===
+
+A DIY Keypad Kit sold by KPRepublic, runs TKG natively.
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: COSPAD
+Hardware Availability: https://aliexpress.com/item/cospad-Custom-Mechanical-Keyboard-Kit-up-tp-24-keys-Supports-TKG-TOOLS-Underglow-RGB-PCB-20/32818383873.html
+
+Only supports on and off for the backlight leds, as they are not connected to a PWM pin.
+
+Supported Layouts:
+
+![Numpad Layout of COSPAD](https://i.imgur.com/t03lXJ4.png)
+![Ortholinear Layout of COSPAD](https://i.imgur.com/mliUcCc.png)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cospad:default
+
+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.