]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/georgi/readme.md
[Keyboard] Snagpad Configurator bugfix and readme refactor (#6381)
[qmk_firmware.git] / keyboards / georgi / readme.md
1 # Georgi
2
3 ![Georgi](https://i.imgur.com/3kUpRrj.jpg)
4
5 A compact 20% (12x2) Split Keyboard for steno and QWERTY. 
6
7 [More info on qmk.fm](http://qmk.fm/georgi/)
8
9 Keyboard Maintainer: [Jeremy Bernhardt](https://github.com/germ)  
10 Hardware Supported: Georgi   
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 georgi:default:dfu
17
18 To just test your build with the default keymap
19    
20     make georgi:default
21
22 Build 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 ## Documentation
25 Is hosted over on [docs.gboards.ca](http://docs.gboards.ca/). Please take a look at the docs for customizing your firmware!
26
27 # Space
28 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). 
29
30 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).
31
32 ## Have an idea?  [Reach out to me!](mailto:bernhardtjeremy@gmail.com)