diff options
Diffstat (limited to 'keyboards/vision_division/readme.md')
| -rw-r--r-- | keyboards/vision_division/readme.md | 38 |
1 files changed, 9 insertions, 29 deletions
diff --git a/keyboards/vision_division/readme.md b/keyboards/vision_division/readme.md index de200d7c5..880c62f58 100644 --- a/keyboards/vision_division/readme.md +++ b/keyboards/vision_division/readme.md | |||
| @@ -1,34 +1,14 @@ | |||
| 1 | vision_division keyboard firmware | 1 | Vision Division |
| 2 | ====================== | 2 | =============== |
| 3 | 3 | ||
| 4 | ## Keyboard Info | 4 | Full Size / Split Linear Keyboard PCB |
| 5 | 5 | ||
| 6 | [See this thread.](https://geekhack.org/index.php?topic=83692.msg2227856#msg2227856) | 6 | Keyboard Maintainer: QMK Community |
| 7 | Hardware Supported: Vision Division PCB | ||
| 8 | Hardware Availability: https://geekhack.org/index.php?topic=83692.msg2227856#msg2227856 | ||
| 7 | 9 | ||
| 8 | Vision/Division is a full size or split keyboard that can be customized due to its pcb. | 10 | Make example for this keyboard (after setting up your build environment): |
| 9 | 11 | ||
| 10 | ## Quantum MK Firmware | 12 | make vision_division-default |
| 11 | 13 | ||
| 12 | For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). | 14 | See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. |
| 13 | |||
| 14 | ## Building | ||
| 15 | |||
| 16 | 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. | ||
| 17 | |||
| 18 | Depending on which keymap you would like to use, you will have to compile slightly differently. | ||
| 19 | |||
| 20 | ### Default | ||
| 21 | |||
| 22 | To build with the default keymap, simply run `make`. | ||
| 23 | |||
| 24 | ### Other Keymaps | ||
| 25 | |||
| 26 | 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. | ||
| 27 | |||
| 28 | To build the firmware binary hex file with a keymap just do `make` with `keymap` option like: | ||
| 29 | |||
| 30 | ``` | ||
| 31 | $ make keymap=[default|jack|<name>] | ||
| 32 | ``` | ||
| 33 | |||
| 34 | 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 | ||
