drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Make the bulk of our keyboards match the readme.md standard

Browse source
This commit is contained in:
skullY 2017-08-16 15:08:16 -07:00 • committed by Jack Humbert
parent 2ee0dc7793
commit 4e73b0b8d7
32 changed files with 355 additions and 1155 deletions
Download patch file Download diff file Expand all files Collapse all files

38
keyboards/vision_division/readme.md
View file

@ -1,34 +1,14 @@
vision_division keyboard firmware
======================
Vision Division
===============
## Keyboard Info
Full Size / Split Linear Keyboard PCB
[See this thread.](https://geekhack.org/index.php?topic=83692.msg2227856#msg2227856)
Keyboard Maintainer: QMK Community
Hardware Supported: Vision Division PCB
Hardware Availability: 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.
Make example for this keyboard (after setting up your build environment):
## Quantum MK Firmware
make vision_division-default
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/`
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.