summaryrefslogtreecommitdiffstats
path: root/keyboard/Bantam44/README.md
diff options
context:
space:
mode:
authorNorberto Monarrez <monarrez.norberto@gmail.com>2016-03-23 10:22:43 -0400
committerNorberto Monarrez <monarrez.norberto@gmail.com>2016-03-23 10:22:43 -0400
commitd0c894cfae5b829774f7ddb6db8ac2d9b1643cc4 (patch)
tree21fbb22dd6149234b3b66132b1ec2559d61b74a9 /keyboard/Bantam44/README.md
parente8951d6e41e364a95f862a1d3544a52b32857148 (diff)
Added files for Bantam-44
Diffstat (limited to 'keyboard/Bantam44/README.md')
-rw-r--r--keyboard/Bantam44/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboard/Bantam44/README.md b/keyboard/Bantam44/README.md
new file mode 100644
index 0000000000..cd059a66c9
--- /dev/null
+++ b/keyboard/Bantam44/README.md
@@ -0,0 +1,24 @@
+Bantam44 keyboard firmware
+======================
+
+## Quantum MK Firmware
+
+For the full Quantum feature list, see [the parent README.md](/README.md).
+
+## Building
+
+Download or clone the whole firmware and navigate to the keyboard/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.
+
+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 `<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 `KEYMAP` option like:
+```
+$ make KEYMAP=[default|jack|<name>]
+```
+Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. \ No newline at end of file