summaryrefslogtreecommitdiff
path: root/keyboards/gboards/gergo/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/gboards/gergo/readme.md')
-rw-r--r--keyboards/gboards/gergo/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/gboards/gergo/readme.md b/keyboards/gboards/gergo/readme.md
new file mode 100644
index 0000000000..b2558e6715
--- /dev/null
+++ b/keyboards/gboards/gergo/readme.md
@@ -0,0 +1,26 @@
+# Gergo
+
+![Gergo](https://cdn.pbrd.co/images/HVglSWD.jpg)
+
+A compact 50% (14x4) Split Keyboard compatible with i2c modules and a trackball.
+
+[More info on qmk.fm](http://qmk.fm/gergo/)
+
+Keyboard Maintainer: [Jane Bernhardt](https://github.com/germ)
+Hardware Supported: Gergo (Kit, Partial, Ready)
+Hardware Availability: [gboards.ca](http://gboards.ca)
+
+## Firmware building
+After cloning the QMK repo and installing dfu-programmer build and flash with. Be sure to reset your keyboard!
+
+ make gboards/gergo:germ:dfu
+
+To just test your build with the default keymap
+
+ make gboards/gergo:germ
+
+Gadgets and options can be enabled/disabled in keyboards/gboards/gergo/keymaps/default/rules.mk . Copy the default directory and make any changes to your layout, if you think they're worth sharing submit a PR!
+
+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).
+
+## Have an idea for a gadget? [Reach out to me!](mailto:bernhardtjeremy@gmail.com)