drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Small tweaks to docs to make them more user friendly (#11518)

Browse source 
* 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>
This commit is contained in:
Joel Challis 2021-01-20 18:46:01 +00:00 • committed by GitHub
parent 1328ab7c7d
commit 4e8166750b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 278 additions and 284 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/newbs_flashing.md
View file

@ -37,18 +37,22 @@ Begin by opening the QMK Toolbox application. You'll want to locate the firmware
If you are on Windows or macOS, there are commands you can use to easily open the current folder in Explorer or Finder.
#### Windows
<!-- tabs:start -->
#### ** Windows **
```
start .
```
#### macOS
#### ** macOS **
```
open .
```
<!-- tabs:end -->
The firmware file always follows this naming format:
```
@ -106,6 +110,9 @@ In this case, you'll have to fall back on specifying the bootloader. See the [Fl
## Test It Out!
Congrats! Your custom firmware has been programmed to your keyboard!
Congrats! Your custom firmware has been programmed to your keyboard and you're ready to test it out!
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.
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.
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.
Still not working? Browse the FAQ topics for more information, or [chat with us on Discord](https://discord.gg/Uq7gcHh).