aboutsummaryrefslogtreecommitdiff
path: root/docs/faq_build.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2019-03-18 14:22:02 -0700
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-03-18 14:22:02 -0700
commitc534a4c775098f2b6cc8e7f36d35cf642f4323a5 (patch)
treef025c6ade37e4fc6bc930e05fe9a734dd273c974 /docs/faq_build.md
parent28e182bc8a2976562e0d76a1332527e0a4be81ea (diff)
downloadqmk_firmware-c534a4c775098f2b6cc8e7f36d35cf642f4323a5.tar.gz
qmk_firmware-c534a4c775098f2b6cc8e7f36d35cf642f4323a5.zip
[Docs] Smallish overhaul of the docs (#5281)
* Fix up Common functions doc * Add to extra commands to flashing doc * Rearrange and touch up Macros * Expand Newbs Flashing guide * Update process_record documentation * Add git to best practices name in sidebar * Expand FAQ for build/flashing * Add deprecated info to functions * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Update docs/faq_build.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Fix up Common functions doc * Make pre-init example accurate * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Zadig Driver catchall * Spelling Depriciated * Completely remove fn_actions section
Diffstat (limited to 'docs/faq_build.md')
-rw-r--r--docs/faq_build.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/faq_build.md b/docs/faq_build.md
index be26a7c58..45d9439b4 100644
--- a/docs/faq_build.md
+++ b/docs/faq_build.md
@@ -15,7 +15,7 @@ or just:
15 15
16 $ sudo make <keyboard>:<keymap>:dfu 16 $ sudo make <keyboard>:<keymap>:dfu
17 17
18Note that running `make` with `sudo` is generally *not* a good idea, and you should use one of the former methods, if possible. 18Note that running `make` with `sudo` is generally ***not*** a good idea, and you should use one of the former methods, if possible.
19 19
20### Linux `udev` Rules 20### Linux `udev` Rules
21On Linux, you'll need proper privileges to access the MCU. You can either use 21On Linux, you'll need proper privileges to access the MCU. You can either use
@@ -47,7 +47,12 @@ If you're using Windows to flash your keyboard, and you are running into issues,
47 47
48Re-running the installation script for MSYS2 may help (eg run `./util/qmk_install.sh` from MSYS2/WSL) or reinstalling the QMK Toolbox may fix the issue. 48Re-running the installation script for MSYS2 may help (eg run `./util/qmk_install.sh` from MSYS2/WSL) or reinstalling the QMK Toolbox may fix the issue.
49 49
50If that doesn't work, then you may need to grab the [Zadig Utility](https://zadig.akeo.ie/). Download this, find the device in question, and select the `WinUS(libusb-1.0)` option, and hit "Reinstall driver". Once you've done that, try flashing your board, again. 50If that doesn't work, then you may need to grab the [Zadig Utility](https://zadig.akeo.ie/). Download this, find the device in question, and select the `WinUSB` option, and hit "Reinstall driver". Once you've done that, try flashing your board, again. If that doesn't work, try all of the options, until one works.
51
52?> There isn't a best option for which driver should be used here. Some options work better on some systems than others. libUSB and WinUSB seem to be the best options here.
53
54If the bootloader doesn't show up in the list for devices, you may need to enable the "List all devices" option in the `Options` menu, and then find the bootloader in question.
55
51 56
52## WINAVR is Obsolete 57## WINAVR is Obsolete
53It is no longer recommended and may cause some problem. 58It is no longer recommended and may cause some problem.