diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/newbs_getting_started.md | 2 | ||||
| -rw-r--r-- | docs/pr_checklist.md | 1 |
2 files changed, 3 insertions, 0 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 91bfa08310..b0d28d89d1 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -172,6 +172,8 @@ For example, to build a firmware for a Clueboard 66% you would use: qmk compile -kb clueboard/66/rev3 -km default +?> The keyboard option is the path relative to the keyboard directory, the above example would be found in `qmk_firmware/keyboards/clueboard/66/rev3`. If you're unsure you can view a full list of supported keyboards with `qmk list-keyboards`. + When it is done you should have a lot of output that ends similar to this: ``` diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index bacb9480da..6dc6c0000d 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -53,6 +53,7 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard - keyboard moves within the repository *must* go through the `develop` branch instead of `master`, so as to ensure compatibility for users - `data/mappings/keyboard_aliases.hjson` must be updated to reflect the move, so users with pre-created configurator keymap.json files continue to detect the correct keyboard +- keyboard updates and refactors (eg. to data driven) *must* go through `develop` to reduce `master` -> `develop` merge conflicts - PR submissions from a `kbfirmware` export (or equivalent) will not be accepted unless converted to new QMK standards -- try `qmk import-kbfirmware` first - `info.json` - With the move to [data driven](https://docs.qmk.fm/#/data_driven_config) keyboard configuration, we encourage contributors to utilise as many features as possible of the info.json [schema](https://github.com/qmk/qmk_firmware/blob/master/data/schemas/keyboard.jsonschema). |