diff options
| author | skullY <skullydazed@gmail.com> | 2017-08-16 15:08:16 -0700 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-08-16 20:36:59 -0400 |
| commit | 4e73b0b8d7750bcddc445b5a52008d4c6cea977d (patch) | |
| tree | e6c54f5d0b334f1e0acc41b6406e8b26900f80b0 /keyboards/bantam44 | |
| parent | 2ee0dc7793165eacfe7ee2a4994d557294988f18 (diff) | |
| download | qmk_firmware-4e73b0b8d7750bcddc445b5a52008d4c6cea977d.tar.gz qmk_firmware-4e73b0b8d7750bcddc445b5a52008d4c6cea977d.zip | |
Make the bulk of our keyboards match the readme.md standard
Diffstat (limited to 'keyboards/bantam44')
| -rw-r--r-- | keyboards/bantam44/readme.md | 29 |
1 files changed, 9 insertions, 20 deletions
diff --git a/keyboards/bantam44/readme.md b/keyboards/bantam44/readme.md index 462f67c12..494800958 100644 --- a/keyboards/bantam44/readme.md +++ b/keyboards/bantam44/readme.md | |||
| @@ -1,25 +1,14 @@ | |||
| 1 | Bantam44 keyboard firmware | 1 | Bantam-44 |
| 2 | ====================== | 2 | === |
| 3 | 3 | ||
| 4 | ## Quantum MK Firmware | 4 | A small mechanical keyboard. |
| 5 | 5 | ||
| 6 | For the full Quantum feature list, see [the parent readme.md](/readme.md). | 6 | Keyboard Maintainer: QMK Community |
| 7 | Hardware Supported: Bantam-44 PCB | ||
| 8 | Hardware Availability: http://www.bantamkeyboards.com | ||
| 7 | 9 | ||
| 8 | ## Building | 10 | Make example for this keyboard (after setting up your build environment): |
| 9 | 11 | ||
| 10 | 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. | 12 | make bantam44-default |
| 11 | 13 | ||
| 12 | Depending on which keymap you would like to use, you will have to compile slightly differently. | 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. |
| 13 | |||
| 14 | ### Default | ||
| 15 | To build with the default keymap, simply run `make default`. | ||
| 16 | |||
| 17 | ### Other Keymaps | ||
| 18 | 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. | ||
| 19 | |||
| 20 | To build the firmware binary hex file with a keymap just do `make` with a keymap like this: | ||
| 21 | |||
| 22 | ``` | ||
| 23 | $ make [default|jack|<name>] | ||
| 24 | ``` | ||
| 25 | Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. \ No newline at end of file | ||
