aboutsummaryrefslogtreecommitdiff
path: root/keyboards/handwired/minorca/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/handwired/minorca/readme.md')
-rw-r--r--keyboards/handwired/minorca/readme.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/keyboards/handwired/minorca/readme.md b/keyboards/handwired/minorca/readme.md
new file mode 100644
index 000000000..93c767954
--- /dev/null
+++ b/keyboards/handwired/minorca/readme.md
@@ -0,0 +1,33 @@
1minorca keyboard firmware
2======================
3Handwired 40% keyboard
4
5http://www.panc.co/blog/minorcasebright-information-page
6
7## Quantum MK Firmware
8
9For the full Quantum feature list, see [the parent readme.md](/readme.md).
10
11## Building
12
13Download 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.
14
15Depending on which keymap you would like to use, you will have to compile slightly differently.
16
17### Default
18To build with the default keymap, simply run `make`.
19
20### Other Keymaps
21Several 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.
22
23To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
24```
25$ make KEYMAP=[default|jack|<name>]
26```
27Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
28
29### Notable forks (which some of the keymap files are from)
30- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
31- [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
32- [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
33- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)