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.

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

Closed
wants to merge 3 commits into from

Conversation

russss
Copy link
Contributor

@russss russss commented Oct 3, 2020

At the risk of me becoming the docs maintainer, this PR:

  • Moves the factory flashing instructions out of the README and into docs/, as most users won't need this
  • Adds some basic smoke-test commands to the README, so people have an example to test that everything's working

@attie
Copy link
Member

attie commented Oct 3, 2020

As you're on this, please could you add a note re: glasgow flash, and it's importance for Windows users?

#206 (comment)

@russss
Copy link
Contributor Author

russss commented Oct 3, 2020

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>
Copy link
Member

@whitequark whitequark left a 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.

@russss
Copy link
Contributor Author

russss commented Oct 5, 2020

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.

Base automatically changed from master to main February 27, 2021 09:59
@whitequark whitequark added the nominated Meta: nominated for next meeting label Aug 2, 2023
@whitequark whitequark removed the nominated Meta: nominated for next meeting label Oct 3, 2023
@whitequark
Copy link
Member

We now have proper documentation so this PR is no longer relevant. Thank you for the work you've done, @russss!

@whitequark whitequark closed this Oct 3, 2023
@russss russss deleted the docs-updates branch October 3, 2023 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants