diff options
author | Erez Zukerman <ezuk@madmimi.com> | 2016-05-25 05:55:29 +0200 |
---|---|---|
committer | Erez Zukerman <ezuk@madmimi.com> | 2016-05-25 05:55:29 +0200 |
commit | d06e940a179b2e81563cf6123461cfcad35f9045 (patch) | |
tree | 58f4bbc22f51cba0c22a6a1ab09a499681f1f89e /keyboard/bantam44/README.md | |
parent | 8bc69afc633d3e199e3ac0a5bf39e4d255f2ce4a (diff) | |
download | qmk_firmware-d06e940a179b2e81563cf6123461cfcad35f9045.tar.gz qmk_firmware-d06e940a179b2e81563cf6123461cfcad35f9045.tar.xz |
[Erez & Jack] Removes keyboards which are not active on qmk
Diffstat (limited to 'keyboard/bantam44/README.md')
-rw-r--r-- | keyboard/bantam44/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboard/bantam44/README.md b/keyboard/bantam44/README.md new file mode 100644 index 000000000..cd059a66c --- /dev/null +++ b/keyboard/bantam44/README.md @@ -0,0 +1,24 @@ +Bantam44 keyboard firmware +====================== + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent README.md](/README.md). + +## Building + +Download or clone the whole firmware and navigate to the keyboard/Bantam44 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 file named `<name>.c` and see keymap document (you can find in top README.md) and existent 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 **__\<name\>.c__** and are stored in the `keymaps` folder.
\ No newline at end of file |