-
Notifications
You must be signed in to change notification settings - Fork 163
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.
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
Move factory flashing instructions and add basic example to README #210
Conversation
As you're on this, please could you add a note re: |
I've added a warning about that to the flashing docs (it doesn't render especially well on GitHub but it looks nice in Sphinx). |
Co-authored-by: Attie Grande <attie@attie.co.uk>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So there are two main issues with PR:
- Factory flashing isn't really "internal", it's a public interface that must be provided because Glasgow is OSHW and a lot of people are ordering boards for themselves. That will probably be even more if/when we ship Edinburgh, optimized for low-cost fabs.
- "Factory flashing" and "flashing" are not the same thing and the WinUSB warning applies to the non-flashed boards, not non-factory-flashed boards. The former term probably needs to be changed.
I'm not sure if it makes more sense for you to fix the PR or for me to do it myself, since the review overhead here would be higher than the actual effort to fix the docs.
I'm happy for you to edit. I still think that the number of people who need to factory flash is going to be small compared to those who have a flashed device and want to get going with it, so it makes sense to put those instructions somewhere other than the README, notwithstanding whether it's classified as "internal" or not. |
We now have proper documentation so this PR is no longer relevant. Thank you for the work you've done, @russss! |
At the risk of me becoming the docs maintainer, this PR:
docs/
, as most users won't need this