diff options
author | Stephen Christie <undersampled@live.com> | 2016-09-19 18:05:58 -0400 |
---|---|---|
committer | Stephen Christie <undersampled@live.com> | 2016-09-19 18:05:58 -0400 |
commit | 57a6828a7a73d7b7c3dd9693e04d6873e2e3d1c2 (patch) | |
tree | bdabbdbdd9fd6de500728721d1865058468871e3 /keyboards/vision_division/readme.md | |
parent | bf2b260429dbc015d49d005065a37441c8f15753 (diff) | |
parent | 5f9c2f63ffb2c58db73e67442134be58bfe2c129 (diff) |
Merge branch 'master' of http://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/vision_division/readme.md')
-rw-r--r-- | keyboards/vision_division/readme.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/keyboards/vision_division/readme.md b/keyboards/vision_division/readme.md new file mode 100644 index 0000000000..de200d7c5b --- /dev/null +++ b/keyboards/vision_division/readme.md @@ -0,0 +1,34 @@ +vision_division keyboard firmware +====================== + +## Keyboard Info + +[See this thread.](https://geekhack.org/index.php?topic=83692.msg2227856#msg2227856) + +Vision/Division is a full size or split keyboard that can be customized due to its pcb. + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). + +## Building + +Download or clone the whole firmware and navigate to the keyboards/vision_division folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. + +Depending on which keymap you would like to use, you will have to compile slightly differently. + +### Default + +To build with the default keymap, simply run `make`. + +### Other Keymaps + +Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files. + +To build the firmware binary hex file with a keymap just do `make` with `keymap` option like: + +``` +$ make keymap=[default|jack|<name>] +``` + +Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`
\ No newline at end of file |