summaryrefslogtreecommitdiff
path: root/keyboards/bantam44/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/bantam44/readme.md')
-rw-r--r--keyboards/bantam44/readme.md29
1 files changed, 9 insertions, 20 deletions
diff --git a/keyboards/bantam44/readme.md b/keyboards/bantam44/readme.md
index 462f67c124..494800958e 100644
--- a/keyboards/bantam44/readme.md
+++ b/keyboards/bantam44/readme.md
@@ -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. \ No newline at end of file
+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.