summaryrefslogtreecommitdiff
path: root/keyboards/rabbit/rabbit68/readme.md
diff options
context:
space:
mode:
authorKai Eckert <gen-github@kaiec.de>2019-09-10 06:36:32 +0200
committerDrashna Jaelre <drashna@live.com>2019-09-09 21:36:32 -0700
commit88908888b88c30653a35fdb254781fd8825a954c (patch)
tree488b50e3c946f60febacce9bc12385f678b3c35d /keyboards/rabbit/rabbit68/readme.md
parent99e58eab0fad1e81e5592e002f85aeea2563d272 (diff)
[Keyboard] Add Rabbit68 Keyboard w/ default,kaiec keymaps. (#6676)
* Add Rabbit68 Keyboard w/ default,kaiec keymaps. * Requested changes by @fauxpark * Change flash command, as suggested by @drashna * Update keyboards/rabbit/rabbit68/readme.md Co-Authored-By: Drashna Jaelre <drashna@live.com> * Add link to Github repo As I per suggestion changed the link above to an image, I added now the link to the project page to the Open Source text, where it actually makes the most sense.
Diffstat (limited to 'keyboards/rabbit/rabbit68/readme.md')
-rw-r--r--keyboards/rabbit/rabbit68/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/rabbit/rabbit68/readme.md b/keyboards/rabbit/rabbit68/readme.md
new file mode 100644
index 0000000000..e263f6c985
--- /dev/null
+++ b/keyboards/rabbit/rabbit68/readme.md
@@ -0,0 +1,20 @@
+Rabbit 68
+===
+
+![Rabbit 68 Project](https://raw.githubusercontent.com/kaiec/rabbit68/master/images/rabbit68-rev1-rendered-bg.jpg)
+
+A compact 68 keys ortholinear keyboard.
+
+Keyboard Maintainer: [Kai Eckert](https://github.com/kaiec)
+Hardware Supported: Rabbit68 PCB rev1
+Hardware Availability: [Open Source](https://github.com/kaiec/rabbit68)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make rabbit/rabbit68:default
+
+Install examples:
+
+ make rabbit/rabbit68:default:flash
+
+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).