sporq/qmk-firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make the bulk of our keyboards match the readme.md standard

Browse Source
This commit is contained in:
skullY
2017-08-16 15:08:16 -07:00
committed by Jack Humbert
parent 2ee0dc7793
commit 4e73b0b8d7
32 changed files with 355 additions and 1155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
keyboards/bantam44/readme.md
View File

@@ -1,25 +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 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 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 a keymap like this:
```
$ make [default|jack|<name>]
```
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
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.