diff options
Diffstat (limited to 'quantum/template/readme.md')
| -rw-r--r-- | quantum/template/readme.md | 39 |
1 files changed, 9 insertions, 30 deletions
diff --git a/quantum/template/readme.md b/quantum/template/readme.md index 33562764d..696df5283 100644 --- a/quantum/template/readme.md +++ b/quantum/template/readme.md @@ -1,36 +1,15 @@ -%KEYBOARD% keyboard firmware -====================== +# %KEYBOARD% -## Quantum MK Firmware + -For the full Quantum feature list, see [the parent readme](/). +A short description of the keyboard/project -## Building +Keyboard Maintainer: [You](https://github.com/yourusername) +Hardware Supported: The PCBs, controllers supported +Hardware Availability: links to where you can find this hardware -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. +Make example for this keyboard (after setting up your build environment): -(Note: replace %KEYBOARD% with the name of your keyboard.) + make planck/rev4:default -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>] -``` +See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
\ No newline at end of file |