summaryrefslogtreecommitdiffstats
path: root/quantum/template/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'quantum/template/readme.md')
-rw-r--r--quantum/template/readme.md20
1 files changed, 14 insertions, 6 deletions
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](/).
## Building
-Download 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.
+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 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, and see keymap documentation (you can find in top readme.md) and existant keymap files.
+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 [default|jack|<name>]
+$ make %KEYBOARD%-[default|jack|<name>]
```
-
-Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.