aboutsummaryrefslogtreecommitdiff
path: root/quantum/template
diff options
context:
space:
mode:
Diffstat (limited to 'quantum/template')
-rw-r--r--quantum/template/config.h5
-rw-r--r--quantum/template/readme.md20
2 files changed, 19 insertions, 6 deletions
diff --git a/quantum/template/config.h b/quantum/template/config.h
index dbca45765..700a56f52 100644
--- a/quantum/template/config.h
+++ b/quantum/template/config.h
@@ -67,6 +67,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
67/* Locking resynchronize hack */ 67/* Locking resynchronize hack */
68#define LOCKING_RESYNC_ENABLE 68#define LOCKING_RESYNC_ENABLE
69 69
70/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
71 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
72 */
73// #define GRAVE_ESC_CTRL_OVERRIDE
74
70/* 75/*
71 * Force NKRO 76 * Force NKRO
72 * 77 *
diff --git a/quantum/template/readme.md b/quantum/template/readme.md
index b16f4cd76..33562764d 100644
--- a/quantum/template/readme.md
+++ b/quantum/template/readme.md
@@ -7,22 +7,30 @@ For the full Quantum feature list, see [the parent readme](/).
7 7
8## Building 8## Building
9 9
10Download or clone the whole firmware and navigate to the keyboards/%KEYBOARD% folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. 10Download 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.
11
12(Note: replace %KEYBOARD% with the name of your keyboard.)
11 13
12Depending on which keymap you would like to use, you will have to compile slightly differently. 14Depending on which keymap you would like to use, you will have to compile slightly differently.
13 15
14### Default 16### Default
15 17
16To build with the default keymap, simply run `make default`. 18To build with the default keymap, simply run `make %KEYBOARD%-default`.
17 19
18### Other Keymaps 20### Other Keymaps
19 21
20Several 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, and see keymap documentation (you can find in top readme.md) and existant keymap files. 22Several 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:
23
24* `qmk_firmware/`
25 * `keyboard/`
26 * `keymaps/`
27 * `config.h` (optional)
28 * `keymap.c`
29 * `readme.md`
30 * `rules.mk` (optional)
21 31
22To build the firmware binary hex file with a keymap just do `make` with a keymap like this: 32To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
23 33
24``` 34```
25$ make [default|jack|<name>] 35$ make %KEYBOARD%-[default|jack|<name>]
26``` 36```
27
28Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.