From b529d5923fc304fc0a5d7cdbb6f3497afc812f48 Mon Sep 17 00:00:00 2001 From: Nic Aitch Date: Sun, 6 Aug 2017 20:22:27 -0500 Subject: [PATCH] Update readme --- keyboards/bananasplit/README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/keyboards/bananasplit/README.md b/keyboards/bananasplit/README.md index 667a02f29d6..b059a0834d5 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|] +``` + +Keymaps follow the format **__\.c__** and are stored in the `keymaps` folder.