summaryrefslogtreecommitdiff
path: root/keyboards/crkbd/readme.md
diff options
context:
space:
mode:
authorJack Humbert2018-06-12 10:59:35 -0400
committerJack Humbert2018-06-12 10:59:35 -0400
commit998ddbb122c9d3e2a77bd4e88c881b225ca0d569 (patch)
treeca91ff7ad3c4866555d1e623fe9ea05276397e1c /keyboards/crkbd/readme.md
parentc0095710a7c7e9bd94aa9f4dd814dc28d718c731 (diff)
parent06487daaddf923d635e8a528d1eb644b875a73f6 (diff)
Merge branch 'master' of github.com:qmk/qmk_firmware into hf/shinydox
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.