diff options
author | peepeetee <43021794+peepeetee@users.noreply.github.com> | 2022-02-12 11:54:48 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-02-11 19:54:48 -0800 |
commit | 17c0ca6fa4f7b6f65b4442c2f5bc32fee914b376 (patch) | |
tree | aecec74184b82d75dd19e4566cf04a3423c6e3c6 /keyboards/gboards/georgi/readme.md | |
parent | 52d6f07a829baf38e16b61f1804bf5dd555ab45d (diff) |
[Keyboard] move g heavy industry boards into /gboards (#16040)
Co-authored-by: zvecr <git@zvecr.com>
Diffstat (limited to 'keyboards/gboards/georgi/readme.md')
-rw-r--r-- | keyboards/gboards/georgi/readme.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/keyboards/gboards/georgi/readme.md b/keyboards/gboards/georgi/readme.md new file mode 100644 index 0000000000..2ba259ab7e --- /dev/null +++ b/keyboards/gboards/georgi/readme.md @@ -0,0 +1,32 @@ +# Georgi + + + +A compact 20% (12x2) Split Keyboard for steno and QWERTY. + +[More info on qmk.fm](http://qmk.fm/georgi/) + +Keyboard Maintainer: [Jane Bernhardt](https://github.com/germ) +Hardware Supported: Georgi +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/georgi:default:dfu + +To just test your build with the default keymap + + make gboards/georgi:default + +Build options can be enabled/disabled in keyboards/gboards/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! + +## Documentation +Is hosted over on [docs.gboards.ca](http://docs.gboards.ca/). Please take a look at the docs for customizing your firmware! + +# Space +The stock firmware leaves 7K free for custom entries. For extra space disable mousekeys in your keymaps rules.mk (3K of space) and remove the Gaming layers (1k). + +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? [Reach out to me!](mailto:bernhardtjeremy@gmail.com) |