You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

33 lines
1.6 KiB

  1. minorca keyboard firmware
  2. ======================
  3. Handwired 40% keyboard
  4. http://www.panc.co/blog/minorcasebright-information-page
  5. ## Quantum MK Firmware
  6. For the full Quantum feature list, see [the parent readme.md](/readme.md).
  7. ## Building
  8. 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.
  9. Depending on which keymap you would like to use, you will have to compile slightly differently.
  10. ### Default
  11. To build with the default keymap, simply run `make`.
  12. ### Other Keymaps
  13. 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.
  14. To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
  15. ```
  16. $ make KEYMAP=[default|jack|<name>]
  17. ```
  18. Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
  19. ### Notable forks (which some of the keymap files are from)
  20. - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
  21. - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
  22. - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
  23. - [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck)