Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Zadig 101 to docs #6585

Merged
merged 8 commits into from
Aug 24, 2019
Merged

Add Zadig 101 to docs #6585

merged 8 commits into from
Aug 24, 2019

Conversation

fauxpark
Copy link
Member

Description

A brief primer on how to use Zadig, how not to use it, and how to get yourself out of the "installed driver on wrong device" pickle.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@yiancar
Copy link
Contributor

yiancar commented Aug 21, 2019

Thanks!

@drashna
Copy link
Member

drashna commented Aug 21, 2019 •
edited
Loading

Don't forget to add a link to the _summary.md file.

Also, should probably link it from the the build faq page that references zadig

@fauxpark
Copy link
Member Author

Which section should it go in?

@drashna
Copy link
Member

drashna commented Aug 21, 2019

FAQ, probably. That or maybe detailed guides.

@zvecr
Copy link
Member

zvecr commented Aug 21, 2019

I would also note the docs I have been recommending recently are the cannonkeys ones https://docs.cannonkeys.com/initial-flash-072/#one-time-setup, while a little more geared towards one board, its more visual.

@zvecr
Copy link
Member

zvecr commented Aug 22, 2019

We should also rip out most of https://docs.qmk.fm/#/faq_build?id=unknown-device-for-dfu-bootloader and point it this new central location.

@drashna
Copy link
Member

drashna commented Aug 22, 2019

Emphatically agree with @zvecr

@fauxpark
Copy link
Member Author

How's this?

I've never actually seen the Toolbox ask to install drivers - and the occasional crash reports related to not having them installed suggests to me that it either doesn't work or is disabled in some way.

@drashna
Copy link
Member

drashna commented Aug 22, 2019

That looks good!

As for the drivers, it's in the readme, but it's .... not great:
https://github.com/qmk/qmk_toolbox#dependencies

@fauxpark
Copy link
Member Author

(a version of) qmk_driver_installer.exe seems to be bundled with the Windows Toolbox, and I believe it's supposed to ask on first run, but I know for a fact that deleting the .config file from AppData doesn't make any difference.

@drashna
Copy link
Member

drashna commented Aug 22, 2019

Yeah, I think that's a big/issue for QMK Toolbox, but I have no idea how to fix that. Though... it may be possible to script it in the installer?

@noroadsleft
Copy link
Member

Thanks!

@noroadsleft noroadsleft merged commit fb7c65d into qmk:master Aug 24, 2019
@fauxpark fauxpark deleted the zadig-docs branch August 24, 2019 06:43
Shinichi-Ohki added a commit to Shinichi-Ohki/qmk_firmware that referenced this pull request Aug 27, 2019
@Shinichi-Ohki
Merge branch 'master' of https://github.com/qmk/qmk_firmware
eaf0c9b 
* 'master' of https://github.com/qmk/qmk_firmware: (42 commits)
  pegasushoof Specify the bootloader to use :flash (qmk#6614)
  Fix Typo in :flash target for missing bootloader (qmk#6615)
  Mars80 Bug: Physical/Electrical Matrix Mismatch (qmk#6612)
  [Keymap] Redox_w Use layer_state_set_user instead of matrix_scan_user (qmk#6608)
  Added OLED Display autoscroll during periods of OLED data inactivity (qmk#6546)
  Refactor `qmk compile-json` to `qmk compile` (qmk#6592)
  RGB Inidcator example for new van pcbs (qmk#6544)
  Add new 60% Tsangan HHKB layout (qmk#6607)
  [Keyboard] Maartenwut Wonderland PCB (qmk#6492)
  Add 2015 revision of Pegasus Hoof to QMK (qmk#6595)
  [Keyboard] New Keyboard: EVE Meteor (qmk#6565)
  updates the coc
  [Keymap] a keymap to "transform" a jj40 info a simil Alpha28, to enjoy its simplicity and power (qmk#6599)
  [Keyboard] Add JNAO keyboard (qmk#6598)
  [Keymap] ISO keymap for TADA68 with programming in mind (qmk#6597)
  [Keymap] Update to userspace kuchosauroand0 (qmk#6596)
  Add 'bootloadHID' flash target (qmk#5587)
  Add Zadig 101 to docs (qmk#6585)
  Add Soft Serial Speed to Diverge3 keyboard config for compatibility (qmk#5076)
  Added 4by3 keyboard (qmk#6547)
  ...
doughsay pushed a commit to doughsay/qmk_firmware that referenced this pull request Aug 31, 2019
@fauxpark @doughsay
Add Zadig 101 to docs (qmk#6585)
6e7c8f6 
* Add Zadig 101 to docs

* Add USBasp bootloader name

* Add links to the page

* Note the usual VIDs and PIDs for the bootloaders

* Add "List All Devices" note, just in case

* Talk about keyboard-specific bootloader procedures

* Send users to the new page in "Unknown Device for DFU Bootloader" section

* Halfkay bootloaders are also an exception here
swanmatch pushed a commit to swanmatch/qmk_firmware that referenced this pull request Sep 3, 2019
@fauxpark @noroadsleft
Add Zadig 101 to docs (qmk#6585)
b1d3955 
* Add Zadig 101 to docs

* Add USBasp bootloader name

* Add links to the page

* Note the usual VIDs and PIDs for the bootloaders

* Add "List All Devices" note, just in case

* Talk about keyboard-specific bootloader procedures

* Send users to the new page in "Unknown Device for DFU Bootloader" section

* Halfkay bootloaders are also an exception here
ripxorip pushed a commit to ripxorip/qmk_firmware that referenced this pull request Dec 3, 2019
@fauxpark
Add Zadig 101 to docs (qmk#6585)
e7b0cc2 
* Add Zadig 101 to docs

* Add USBasp bootloader name

* Add links to the page

* Note the usual VIDs and PIDs for the bootloaders

* Add "List All Devices" note, just in case

* Talk about keyboard-specific bootloader procedures

* Send users to the new page in "Unknown Device for DFU Bootloader" section

* Halfkay bootloaders are also an exception here
ridingqwerty pushed a commit to ridingqwerty/qmk_firmware that referenced this pull request Jan 10, 2020
@fauxpark @noroadsleft
Add Zadig 101 to docs (qmk#6585)
798b799 
* Add Zadig 101 to docs

* Add USBasp bootloader name

* Add links to the page

* Note the usual VIDs and PIDs for the bootloaders

* Add "List All Devices" note, just in case

* Talk about keyboard-specific bootloader procedures

* Send users to the new page in "Unknown Device for DFU Bootloader" section

* Halfkay bootloaders are also an exception here
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
@fauxpark @noroadsleft
Add Zadig 101 to docs (qmk#6585)
959f8fb 
* Add Zadig 101 to docs

* Add USBasp bootloader name

* Add links to the page

* Note the usual VIDs and PIDs for the bootloaders

* Add "List All Devices" note, just in case

* Talk about keyboard-specific bootloader procedures

* Send users to the new page in "Unknown Device for DFU Bootloader" section

* Halfkay bootloaders are also an exception here
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zvecr zvecr zvecr left review comments

@yiancar yiancar yiancar left review comments

@noroadsleft noroadsleft noroadsleft approved these changes

@drashna drashna drashna approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@fauxpark @yiancar @drashna @zvecr @noroadsleft