summaryrefslogtreecommitdiffstats
path: root/keyboards/miuni32
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/miuni32')
-rw-r--r--keyboards/miuni32/readme.md32
1 files changed, 9 insertions, 23 deletions
diff --git a/keyboards/miuni32/readme.md b/keyboards/miuni32/readme.md
index 36696ddbcb..3f3ddc8dfb 100644
--- a/keyboards/miuni32/readme.md
+++ b/keyboards/miuni32/readme.md
@@ -1,28 +1,14 @@
-miuni32 keyboard firmware
-======================
+miuni32
+=======
-## Quantum MK Firmware
+A compact 30% keyboard.
-For the full Quantum feature list, see [the parent readme](/).
+Keyboard Maintainer: QMK Community
+Hardware Supported: miuni32 PCB
+Hardware Availability: https://zealpc.net/products/miuni32
-## Building
+Make example for this keyboard (after setting up your build environment):
-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.
+ make miuni32-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 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.
+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.