aboutsummaryrefslogtreecommitdiff
path: root/keyboards/georgi/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/georgi/readme.md')
-rw-r--r--keyboards/georgi/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/georgi/readme.md b/keyboards/georgi/readme.md
new file mode 100644
index 000000000..03e2e3d83
--- /dev/null
+++ b/keyboards/georgi/readme.md
@@ -0,0 +1,29 @@
1# Georgi
2
3![Georgi](https://i.imgur.com/3kUpRrj.jpg)
4
5A compact 20% (12x2) Split Keyboard for steno and QWERTY.
6
7[More info on qmk.fm](http://qmk.fm/georgi/)
8
9Keyboard Maintainer: [Jeremy Bernhardt](https://github.com/germ)
10Hardware Supported: Georgi
11Hardware Availability: [gboards.ca](http://gboards.ca)
12
13## Firmware building
14After cloning the QMK repo and installing dfu-programmer build and flash with. Be sure to reset your keyboard!
15
16 make georgi:default:dfu
17
18To just test your build with the default keymap
19
20 make georgi:default
21
22Build options can be enabled/disabled in keyboards/georgi/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# Space
25The stock firmware uses nearly all of the flash avalible. For custom dictionary modifications, disable mousekeys in your keymaps rules.mk (4K of space) and remove the Gaming layers. I've done this already in the provided keymap 'template'.
26
27See 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).
28
29## Have an idea? [Reach out to me!](mailto:bernhardtjeremy@gmail.com)