diff options
| author | Joel Challis <git@zvecr.com> | 2021-01-20 18:46:01 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-20 18:46:01 +0000 |
| commit | 4e8166750b21cfd3feaba0d6024087fb5c76bca9 (patch) | |
| tree | c124714e565321818485b96509fd70026fe49f84 /docs/newbs_flashing.md | |
| parent | 1328ab7c7defdca40872273147f387618b1a48c3 (diff) | |
| download | qmk_firmware-4e8166750b21cfd3feaba0d6024087fb5c76bca9.tar.gz qmk_firmware-4e8166750b21cfd3feaba0d6024087fb5c76bca9.zip | |
Small tweaks to docs to make them more user friendly (#11518)
* first pass
* firmware firmware?
* Split out debug + testing docs
* tidy up duplicate css
* Add extra info to debug example
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'docs/newbs_flashing.md')
| -rw-r--r-- | docs/newbs_flashing.md | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/docs/newbs_flashing.md b/docs/newbs_flashing.md index 04c7c55ae..7ce1f8493 100644 --- a/docs/newbs_flashing.md +++ b/docs/newbs_flashing.md | |||
| @@ -37,18 +37,22 @@ Begin by opening the QMK Toolbox application. You'll want to locate the firmware | |||
| 37 | 37 | ||
| 38 | If you are on Windows or macOS, there are commands you can use to easily open the current folder in Explorer or Finder. | 38 | If you are on Windows or macOS, there are commands you can use to easily open the current folder in Explorer or Finder. |
| 39 | 39 | ||
| 40 | #### Windows | 40 | <!-- tabs:start --> |
| 41 | |||
| 42 | #### ** Windows ** | ||
| 41 | 43 | ||
| 42 | ``` | 44 | ``` |
| 43 | start . | 45 | start . |
| 44 | ``` | 46 | ``` |
| 45 | 47 | ||
| 46 | #### macOS | 48 | #### ** macOS ** |
| 47 | 49 | ||
| 48 | ``` | 50 | ``` |
| 49 | open . | 51 | open . |
| 50 | ``` | 52 | ``` |
| 51 | 53 | ||
| 54 | <!-- tabs:end --> | ||
| 55 | |||
| 52 | The firmware file always follows this naming format: | 56 | The firmware file always follows this naming format: |
| 53 | 57 | ||
| 54 | ``` | 58 | ``` |
| @@ -106,6 +110,9 @@ In this case, you'll have to fall back on specifying the bootloader. See the [Fl | |||
| 106 | 110 | ||
| 107 | ## Test It Out! | 111 | ## Test It Out! |
| 108 | 112 | ||
| 109 | Congrats! Your custom firmware has been programmed to your keyboard! | 113 | Congrats! Your custom firmware has been programmed to your keyboard and you're ready to test it out! |
| 114 | |||
| 115 | With a little bit of luck everything will work perfectly, but if not there are steps that will help you figure out what's wrong. | ||
| 116 | Testing your keyboard is usually pretty straightforward. Press every single key and make sure it sends the keys you expect. You can use [QMK Configurator](https://config.qmk.fm/#/test/)'s test mode to check your keyboard, even if it doesn't run QMK. | ||
| 110 | 117 | ||
| 111 | Give it a try and make sure everything works the way you want it to. We've written [Testing and Debugging](newbs_testing_debugging.md) to round out this guide, so head over there to learn about validating your firmware and how to troubleshoot your custom functionality. | 118 | Still not working? Browse the FAQ topics for more information, or [chat with us on Discord](https://discord.gg/Uq7gcHh). |