mirrors/opensteno_qmk
1
0
Fork 0
mirror of https://github.com/openstenoproject/qmk synced 2024-11-10 10:39:09 +00:00
Code Issues Projects Releases Packages Wiki Activity
opensteno_qmk/quantum/template
History
skullydazed 4cdcbdb861 Remove all Makefiles from the keyboards directory. (#1660) 
* Remove all Makefiles from the keyboards directory.

* update keymaps added in the last 8 days

* Ignore keyboard/keymap makefiles

* update hand_wire to reflect our new Makefile-less reality

* Update the make guide to reflect the new reality

* move planck keymap options to rules.mk

* update planck keymaps 4real

* trigger travis

* add back build_keyboard.mk

* restore changes to build_keyboard
2017-09-08 13:47:50 -04:00
..
keymaps/default Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
config.h add description of new option to docs and add option (commented out) into template. 2017-08-11 16:54:10 -04:00
Makefile Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
readme.md Remove all Makefiles from the keyboards directory. (#1660) 2017-09-08 13:47:50 -04:00
rules.mk Fix #1135 by changing the default to at90usb1286 2017-06-24 15:28:13 -07:00
template.c Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
template.h Merge pull request #1184 from osamuaoki/master 2017-03-30 08:45:56 -04:00

readme.md

%KEYBOARD% keyboard firmware

Quantum MK Firmware

For the full Quantum feature list, see the parent readme.

Building

Download or clone the whole firmware and navigate to the root folder. Once your dev env is setup, you'll be able to type make %KEYBOARD%-default to generate your .hex - you can then use the Teensy Loader to program your .hex file.

(Note: replace %KEYBOARD% with the name of your keyboard.)

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 %KEYBOARD%-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. Create a readme.md and a keymap.c file to complete your new keymap. When you are done your file tree should look like this:

  • qmk_firmware/
    • keyboard/
      • keymaps/
        • config.h (optional)
        • keymap.c
        • readme.md
        • rules.mk (optional)

To build the firmware binary hex file with a keymap just do make with a keymap like this:

$ make %KEYBOARD%-[default|jack|<name>]