X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=keyboards%2Fbantam44%2Freadme.md;h=08a5167c6f99d3a316ea95930bf21248487d6b6f;hb=d686c0ea43d6a9db7768da64ee54c3ba25c018f7;hp=89d7f9d053e4e72ae1cb40bad7dbc0bdd92f92d4;hpb=d889648d5373b7ff77dc7bc4b369c628e8336b45;p=qmk_firmware.git diff --git a/keyboards/bantam44/readme.md b/keyboards/bantam44/readme.md index 89d7f9d05..08a5167c6 100644 --- a/keyboards/bantam44/readme.md +++ b/keyboards/bantam44/readme.md @@ -1,24 +1,14 @@ -Bantam44 keyboard firmware -====================== +Bantam-44 +=== -## Quantum MK Firmware +A small mechanical keyboard. -For the full Quantum feature list, see [the parent readme.md](/readme.md). +Keyboard Maintainer: QMK Community +Hardware Supported: Bantam-44 PCB +Hardware Availability: http://www.bantamkeyboards.com -## Building +Make example for this keyboard (after setting up your build environment): -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. + make bantam44:default -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 `.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|] -``` -Keymaps follow the format **__\.c__** and are stored in the `keymaps` folder. \ No newline at end of file +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.