qmk-firmware/keyboards/bantam44/readme.md

25 lines
1.0 KiB
Markdown
Raw Normal View History

2016-03-23 14:22:43 +00:00
Bantam44 keyboard firmware
======================
## Quantum MK Firmware
For the full Quantum feature list, see [the parent readme.md](/readme.md).
2016-03-23 14:22:43 +00:00
## Building
Download or clone the whole firmware and navigate to the keyboards/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.
2016-03-23 14:22:43 +00:00
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`.
2016-03-23 14:22:43 +00:00
### 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.
2016-03-23 14:22:43 +00:00
To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
2016-03-23 14:22:43 +00:00
```
$ make [default|jack|<name>]
2016-03-23 14:22:43 +00:00
```
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.