diff options
Diffstat (limited to 'keyboards/gergo/readme.md')
| -rw-r--r-- | keyboards/gergo/readme.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/gergo/readme.md b/keyboards/gergo/readme.md new file mode 100644 index 000000000..8fefcfe8d --- /dev/null +++ b/keyboards/gergo/readme.md | |||
| @@ -0,0 +1,26 @@ | |||
| 1 | # Gergo | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | A compact 50% (14x4) Split Keyboard compatible with i2c modules and a trackball. | ||
| 6 | |||
| 7 | [More info on qmk.fm](http://qmk.fm/gergo/) | ||
| 8 | |||
| 9 | Keyboard Maintainer: [Jeremy Bernhardt](https://github.com/germ) | ||
| 10 | Hardware Supported: Gergo (Kit, Partial, Ready) | ||
| 11 | Hardware Availability: [gboards.ca](http://gboards.ca) | ||
| 12 | |||
| 13 | ## Firmware building | ||
| 14 | After cloning the QMK repo and installing dfu-programmer build and flash with. Be sure to reset your keyboard! | ||
| 15 | |||
| 16 | make gergo:germ:dfu | ||
| 17 | |||
| 18 | To just test your build with the default keymap | ||
| 19 | |||
| 20 | make gergo:germ | ||
| 21 | |||
| 22 | Gadgets and options can be enabled/disabled in keyboards/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! | ||
| 23 | |||
| 24 | 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). | ||
| 25 | |||
| 26 | ## Have an idea for a gadget? [Reach out to me!](mailto:bernhardtjeremy@gmail.com) | ||
