diff options
author | Adam YH Lee <adam.yh.lee@gmail.com> | 2016-11-21 08:22:14 -0800 |
---|---|---|
committer | Adam YH Lee <adam.yh.lee@gmail.com> | 2017-04-03 20:34:10 -0700 |
commit | e18768aa77985e3695f34b71f0e84547293e8104 (patch) | |
tree | 72761cb6dc3b22799c623a5f6f77eca8fbd7b17f /keyboards/miuni32/readme.md | |
parent | 3b990c08dcc0e57875e9220a5e6371f60679c7ae (diff) | |
download | qmk_firmware-e18768aa77985e3695f34b71f0e84547293e8104.tar.gz |
Add B1gtuna Miuni32
Miuni32 is a 30% ortholinear board.
Please visit www.bigtuna.io for more information.
Diffstat (limited to 'keyboards/miuni32/readme.md')
-rw-r--r-- | keyboards/miuni32/readme.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/miuni32/readme.md b/keyboards/miuni32/readme.md new file mode 100644 index 000000000..36696ddbc --- /dev/null +++ b/keyboards/miuni32/readme.md @@ -0,0 +1,28 @@ +miuni32 keyboard firmware +====================== + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent readme](/). + +## Building + +Download or clone the whole firmware and navigate to the keyboards/miuni32 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 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 a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant 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. |