diff options
| author | Nic Aitch <nic@nicinabox.com> | 2017-08-06 20:22:27 -0500 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-08-06 22:46:44 -0400 |
| commit | b529d5923fc304fc0a5d7cdbb6f3497afc812f48 (patch) | |
| tree | bb5a07873eb6c7d2822cecf9096d15343bed79b7 | |
| parent | fb0d4e96e89c1219480f3f79a6e18be484089ea9 (diff) | |
| download | qmk_firmware-b529d5923fc304fc0a5d7cdbb6f3497afc812f48.tar.gz qmk_firmware-b529d5923fc304fc0a5d7cdbb6f3497afc812f48.zip | |
Update readme
| -rw-r--r-- | keyboards/bananasplit/README.md | 28 |
1 files changed, 27 insertions, 1 deletions
diff --git a/keyboards/bananasplit/README.md b/keyboards/bananasplit/README.md index 667a02f29d..b059a0834d 100644 --- a/keyboards/bananasplit/README.md +++ b/keyboards/bananasplit/README.md @@ -1,3 +1,29 @@ -# BananaSplit60 +# BananaSplit60 keyboard firmware Ported from evangs/tmk_keyboard + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent readme](/). + +## Building + +Download or clone the whole firmware and navigate to the keyboards/bananasplit 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 default`. + +### 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 a keymap like this: + +``` +$ make [default|jack|<name>] +``` + +Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. |