diff options
author | Balz Guenat <balz.guenat@gmail.com> | 2017-08-07 21:54:06 +0200 |
---|---|---|
committer | Balz Guenat <balz.guenat@gmail.com> | 2017-08-07 21:54:06 +0200 |
commit | d18df8ef7a7e0528a29fdc96d4843ace54605121 (patch) | |
tree | 44f75b9bccd3efa130d622736726a5f1c83531f6 /keyboards/bananasplit/README.md | |
parent | 308bec28bb76f4305d0f084252d7cf207f1b3d83 (diff) | |
parent | 933701c2129c0c585ecd8ba37c41b091a7dc687f (diff) | |
download | firmware-d18df8ef7a7e0528a29fdc96d4843ace54605121.tar.gz firmware-d18df8ef7a7e0528a29fdc96d4843ace54605121.tar.bz2 firmware-d18df8ef7a7e0528a29fdc96d4843ace54605121.zip |
Merge remote-tracking branch 'upstream/master' into bananasplit
# Conflicts:
# keyboards/bananasplit/Makefile
# keyboards/bananasplit/bananasplit.c
# keyboards/bananasplit/bananasplit.h
# keyboards/bananasplit/config.h
# keyboards/bananasplit/keymaps/default/keymap.c
# keyboards/bananasplit/rules.mk
Diffstat (limited to 'keyboards/bananasplit/README.md')
-rw-r--r-- | keyboards/bananasplit/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/bananasplit/README.md b/keyboards/bananasplit/README.md new file mode 100644 index 000000000..b059a0834 --- /dev/null +++ b/keyboards/bananasplit/README.md @@ -0,0 +1,29 @@ +# 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. |