summaryrefslogtreecommitdiffstats
path: root/keyboards/crkbd/readme.md
diff options
context:
space:
mode:
authorKosuke Adachi <ks@fstn.jp>2018-06-09 00:28:28 +0200
committerDrashna Jaelre <drashna@live.com>2018-06-09 00:28:28 +0200
commit710937e4ef1e14d82261fc439aa6fcfcdbd64bf5 (patch)
tree6226a1d3027634af4b4508dce101ff938f356782 /keyboards/crkbd/readme.md
parent300cf977c93b9b37a57643ddbfa8d0bd13b29e18 (diff)
downloadqmk_firmware-710937e4ef1e14d82261fc439aa6fcfcdbd64bf5.tar.gz
qmk_firmware-710937e4ef1e14d82261fc439aa6fcfcdbd64bf5.tar.xz
Add corne keyboard (#3119)
* Fork from helix * Move rev2 to rev1 * Remove unused settings * Move split_util to outof rev * Setup KEYMAP for crkbd * Remove old image * Move keymaps directory and glcdfont.c * Remove AUDIO in keymap * Show keylog * Show keylogs * Show time log * Remove EISU/KANA * Use KEYMAP_kc * Remove iota_gfx_record_user wrapping * Remove unused settings for layer * Add keylogger.c * Fix uppercase letters to lower * Add timelogger.c * Default RGBLED_NUM = 27 * Remove unused setting * Add mode icon reader * Add matrix_write_ln * Add layer_state_reader * Move to lib directory * Rename functions * Add host_led_state_reader * Add logo_reader * Cleaning of iota_gfx_task * Fix bugs and add key defines * Remove unnecessary comments * Update crkbd readme * Move libs to lib directories * Rename KEYMAP to LAYOUT
Diffstat (limited to 'keyboards/crkbd/readme.md')
-rw-r--r--keyboards/crkbd/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/crkbd/readme.md b/keyboards/crkbd/readme.md
new file mode 100644
index 000000000..2f9f047a4
--- /dev/null
+++ b/keyboards/crkbd/readme.md
@@ -0,0 +1,17 @@
+Crkbd
+===
+
+![Crkbd](https://user-images.githubusercontent.com/736191/40575636-6fba63a4-6123-11e8-9ca0-3f990f1f9f4c.jpg)
+
+![Crkbd](https://user-images.githubusercontent.com/736191/40887871-0eead5dc-678a-11e8-9518-e3ad9e5d2bac.png)
+
+A split keyboard with 3x6 vertically staggered keys and 3 thumb keys.
+
+Keyboard Maintainer: [foostan](https://github.com/foostan/) [@foostan](https://twitter.com/foostan)
+Hardware Supported: Crkbd PCB, Pro Micro
+Hardware Availability: [PCB & Case Data](https://github.com/foostan/crkbd)
+Make example for this keyboard (after setting up your build environment):
+
+ make crkbd: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.