diff options
| author | Albert Y <76888457+filterpaper@users.noreply.github.com> | 2023-06-06 13:17:39 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-05 23:17:39 -0600 |
| commit | 43ce7b0df5dca3b0b9d2d87f91a2dea936250d0e (patch) | |
| tree | 0330b54817400750f7eda5dc8bad8ff9eef1bbc6 | |
| parent | 9167e66ca7a8293748df7349493ecc972ac6cb4b (diff) | |
[Docs] Highlight keymap name entry (#21138)
| -rw-r--r-- | docs/newbs_building_firmware_workflow.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/newbs_building_firmware_workflow.md b/docs/newbs_building_firmware_workflow.md index 51ce304901..e0cfdc77df 100644 --- a/docs/newbs_building_firmware_workflow.md +++ b/docs/newbs_building_firmware_workflow.md @@ -85,6 +85,8 @@ Visit the [QMK Configurator](https://config.qmk.fm/#/) to create a keymap file: 3. Customise the key layout according to your preference. 4. Select download next to **KEYMAP.JSON** and save the JSON file into the `~/qmk_keymap/` folder. +!> **Important:** Make sure that the GitHub username you use in step 2 is correct. If it is not, the build process will fail to locate your files in the right folder. + ### Add a GitHub Action workflow Open the file `~/qmk_keymap/.github/workflows/build.yml` with your favorite [text editor](newbs_learn_more_resources.md#text-editor-resources), paste the following workflow content, and save it: |