summaryrefslogtreecommitdiffstats
path: root/keyboards/gherkin/README.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-08-16 15:08:16 -0700
committerJack Humbert <jack.humb@gmail.com>2017-08-16 20:36:59 -0400
commit4e73b0b8d7750bcddc445b5a52008d4c6cea977d (patch)
treee6c54f5d0b334f1e0acc41b6406e8b26900f80b0 /keyboards/gherkin/README.md
parent2ee0dc7793165eacfe7ee2a4994d557294988f18 (diff)
Make the bulk of our keyboards match the readme.md standard
Diffstat (limited to 'keyboards/gherkin/README.md')
-rw-r--r--keyboards/gherkin/README.md20
1 files changed, 13 insertions, 7 deletions
diff --git a/keyboards/gherkin/README.md b/keyboards/gherkin/README.md
index 0a3d6fabe0..4d2261829e 100644
--- a/keyboards/gherkin/README.md
+++ b/keyboards/gherkin/README.md
@@ -1,12 +1,18 @@
+Gherkin
+===
-About
-------
+A 30 key keyboard.
-First pass at adding support for the gherkin keyboard. Compiles but completely
-untested. Intended to kick-start development.
-
-* [Gherkin project on 40% Keyboards](http://www.40percent.club/2016/11/gherkin.html)
* [The original TMK firmware](https://github.com/di0ib/tmk_keyboard/tree/master/keyboard/gherkin)
-Credit to JadedC for the initial work.
+Keyboard Maintainer: QMK Community
+Hardware Supported: Gherkin PCB
+Hardware Availability: [Gherkin project on 40% Keyboards](http://www.40percent.club/2016/11/gherkin.html)
+
+Make example for this keyboard (after setting up your build environment):
+ make atreus-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.
+First pass at adding support for the gherkin keyboard. Compiles but completely
+untested. Intended to kick-start development.