]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/handwired/minorca/readme.md
Fix Numbrero Handwired make example in readme
[qmk_firmware.git] / keyboards / handwired / minorca / readme.md
index 93c767954ddd9f2bc93616fb5d00932a7e9ccc34..c910459603f4b025682a144956a494273ab1cc8d 100644 (file)
@@ -1,33 +1,13 @@
-minorca keyboard firmware
-======================
-Handwired 40% keyboard
+# minorca
 
-http://www.panc.co/blog/minorcasebright-information-page
+A handwired 40% keyboard by panc.co.
 
-## Quantum MK Firmware
+Keyboard Maintainer: [The QMK Community](https://github.com/qmk)  
+Hardware Supported: panc.co minorca  
+Hardware Availability: [panc.co](https://www.panc.co/blog/minorcasebright-information-page)
 
-For the full Quantum feature list, see [the parent readme.md](/readme.md).
+Make example for this keyboard (after setting up your build environment):
 
-## Building
+    make handwired/minorca:default
 
-Download or clone the whole firmware and navigate to the keyboards/planck folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button. 
-
-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` in the keymaps folder, 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.
-
-### Notable forks (which some of the keymap files are from)
-- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
-- [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
-- [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
-- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).