summaryrefslogtreecommitdiff
path: root/keyboards/ck60i/readme.md
diff options
context:
space:
mode:
authorÁlvaro A. Volpato <alvaro.volpato@usp.br>2021-01-11 04:40:26 -0300
committerGitHub <noreply@github.com>2021-01-10 23:40:26 -0800
commite71f7a1c9f09ed7c813ee4757e161b79ed1b73ff (patch)
tree5f7ee0410b3bc15c73304a3f7b3c63d9e0f74649 /keyboards/ck60i/readme.md
parent2e0f4d7e2a5440599d7f89cad133add7974d6c63 (diff)
[Keyboard] CK60i support (#11432)
* Initial CK60i support * Update README, add HAL_PWM and remove AUDIO and BLUETOOTH from rules.mk * VIA support * Fix VIA_ENABLE to 'yes' * Remove CONSOLE_ENABLE from rules.mk * attribute weak for encoder callback * Remove KC_NO definition from default keymap Co-authored-by: Gondolindrim <alvaro.augusto.volpato@gmail.com>
Diffstat (limited to 'keyboards/ck60i/readme.md')
-rw-r--r--keyboards/ck60i/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/ck60i/readme.md b/keyboards/ck60i/readme.md
new file mode 100644
index 0000000000..2214c973a8
--- /dev/null
+++ b/keyboards/ck60i/readme.md
@@ -0,0 +1,25 @@
+# CandyKeys CK60i QMK firmware
+
+## Introduction
+
+This is the QMK firmware repository for the CK60i PCB. This is a universal 60% tray mount PCB sold by CandyKeys and designed by Gondolindrim.
+
+## Layouts
+
+The CK60i supports:
+
+- ISO layout;
+- Tsangan bottom row;
+- Split right shift, split backspace
+
+## Availability
+
+The CK60i is available for purchase through [Candy Keys' store](http://candykeys.com).
+
+## How to compile
+
+After setting up your build environment, you can compile the CK60i default keymap by using:
+
+ make ck60i:default
+
+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).