diff options
Diffstat (limited to 'keyboards/bananasplit/README.md')
| -rw-r--r-- | keyboards/bananasplit/README.md | 32 |
1 files changed, 9 insertions, 23 deletions
diff --git a/keyboards/bananasplit/README.md b/keyboards/bananasplit/README.md index b059a0834..cd1e15d77 100644 --- a/keyboards/bananasplit/README.md +++ b/keyboards/bananasplit/README.md | |||
| @@ -1,29 +1,15 @@ | |||
| 1 | # BananaSplit60 keyboard firmware | 1 | BananaSplit60 |
| 2 | === | ||
| 2 | 3 | ||
| 3 | Ported from evangs/tmk_keyboard | 4 | A 60% PCB featuring a split spacebar. |
| 4 | 5 | ||
| 5 | ## Quantum MK Firmware | 6 | Keyboard Maintainer: QMK Community |
| 7 | Hardware Supported: BananaSplit60 PCB | ||
| 8 | Hardware Availability: https://thevankeyboards.com/products/gb-bananasplit-60-keyboard-kit?variant=42149104910 | ||
| 6 | 9 | ||
| 7 | For the full Quantum feature list, see [the parent readme](/). | 10 | Make example for this keyboard (after setting up your build environment): |
| 8 | 11 | ||
| 9 | ## Building | 12 | make bananasplit:default |
| 10 | 13 | ||
| 11 | 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. | 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. |
| 12 | 15 | ||
| 13 | Depending on which keymap you would like to use, you will have to compile slightly differently. | ||
| 14 | |||
| 15 | ### Default | ||
| 16 | |||
| 17 | To build with the default keymap, simply run `make default`. | ||
| 18 | |||
| 19 | ### Other Keymaps | ||
| 20 | |||
| 21 | 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. | ||
| 22 | |||
| 23 | To build the firmware binary hex file with a keymap just do `make` with a keymap like this: | ||
| 24 | |||
| 25 | ``` | ||
| 26 | $ make [default|jack|<name>] | ||
| 27 | ``` | ||
| 28 | |||
| 29 | Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. | ||
