Keyboard: handwired/minorca Refactor, Configurator support and readme cleanup (#4571)
* handwired/minorca: refactor - Refactored keymaps to use a layout macro, which was added to minorca.h. - keymaps now use QMK_KEYBOARD_H include - removed redundant KC_TRNS and KC_NO definitions - rgb keymap refactor to use QMK core layer switching and Mod-Tap keycodes * handwired/minorca: Configurator support * handwired/minorca: readme cleanup Restructure readme file to current QMK template.pull/4575/head
noroadsleft
6 years ago
committed by
Drashna Jaelre
parent
afb4a43677
commit
5b7260fc53
@ -0,0 +1,55 @@
|
|||||||
|
{
|
||||||
|
"keyboard_name": "Minorca Handwired",
|
||||||
|
"url": "",
|
||||||
|
"maintainer": "qmk",
|
||||||
|
"width": 12,
|
||||||
|
"height": 4,
|
||||||
|
"layouts": {
|
||||||
|
"LAYOUT": {
|
||||||
|
"layout": [
|
||||||
|
{"label":"KA00", "x":0, "y":0},
|
||||||
|
{"label":"KA01", "x":1, "y":0},
|
||||||
|
{"label":"KA02", "x":2, "y":0},
|
||||||
|
{"label":"KA03", "x":3, "y":0},
|
||||||
|
{"label":"KA04", "x":4, "y":0},
|
||||||
|
{"label":"KA05", "x":5, "y":0},
|
||||||
|
{"label":"KA06", "x":6, "y":0},
|
||||||
|
{"label":"KA07", "x":7, "y":0},
|
||||||
|
{"label":"KA08", "x":8, "y":0},
|
||||||
|
{"label":"KA09", "x":9, "y":0},
|
||||||
|
{"label":"KA10", "x":10, "y":0},
|
||||||
|
{"label":"KA11", "x":11, "y":0},
|
||||||
|
{"label":"KB00", "x":0, "y":1, "w":1.25},
|
||||||
|
{"label":"KB01", "x":1.25, "y":1},
|
||||||
|
{"label":"KB02", "x":2.25, "y":1},
|
||||||
|
{"label":"KB03", "x":3.25, "y":1},
|
||||||
|
{"label":"KB04", "x":4.25, "y":1},
|
||||||
|
{"label":"KB05", "x":5.25, "y":1},
|
||||||
|
{"label":"KB06", "x":6.25, "y":1},
|
||||||
|
{"label":"KB07", "x":7.25, "y":1},
|
||||||
|
{"label":"KB08", "x":8.25, "y":1},
|
||||||
|
{"label":"KB09", "x":9.25, "y":1},
|
||||||
|
{"label":"KB11", "x":10.25, "y":1, "w":1.75},
|
||||||
|
{"label":"KC00", "x":0, "y":2, "w":1.75},
|
||||||
|
{"label":"KC02", "x":1.75, "y":2},
|
||||||
|
{"label":"KC03", "x":2.75, "y":2},
|
||||||
|
{"label":"KC04", "x":3.75, "y":2},
|
||||||
|
{"label":"KC05", "x":4.75, "y":2},
|
||||||
|
{"label":"KC06", "x":5.75, "y":2},
|
||||||
|
{"label":"KC07", "x":6.75, "y":2},
|
||||||
|
{"label":"KC08", "x":7.75, "y":2},
|
||||||
|
{"label":"KC09", "x":8.75, "y":2},
|
||||||
|
{"label":"KC10", "x":9.75, "y":2},
|
||||||
|
{"label":"KC11", "x":10.75, "y":2, "w":1.25},
|
||||||
|
{"label":"KD00", "x":0, "y":3, "w":1.25},
|
||||||
|
{"label":"KD02", "x":1.25, "y":3, "w":1.25},
|
||||||
|
{"label":"KD03", "x":2.5, "y":3, "w":1.25},
|
||||||
|
{"label":"KD04", "x":3.75, "y":3, "w":2.25},
|
||||||
|
{"label":"KD07", "x":6, "y":3, "w":2.25},
|
||||||
|
{"label":"KD09", "x":8.25, "y":3, "w":1.25},
|
||||||
|
{"label":"KD10", "x":9.5, "y":3},
|
||||||
|
{"label":"KD11", "x":10.5, "y":3, "w":1.5}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -1,33 +1,13 @@
|
|||||||
minorca keyboard firmware
|
# minorca
|
||||||
======================
|
|
||||||
Handwired 40% keyboard
|
|
||||||
|
|
||||||
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.
|
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).
|
||||||
|
|
||||||
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)
|
|
||||||
|
|||||||
Loading…
Reference in new issue