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

Circuitpython Installer Documentation page #1404

Open
FoamyGuy opened this issue May 16, 2024 · 3 comments
Open

Circuitpython Installer Documentation page #1404

FoamyGuy opened this issue May 16, 2024 · 3 comments

Comments

@FoamyGuy
Copy link
Contributor

It would be nice to have a page somewhere that documents more specifically what the choices posed by the installer mean.

image

I am unsure about the difference between the "Full" vs. "Upgrade" within these choices, or if there is any difference between "upgrade / install" vs. just "upgrade".

Unless there are some rules or restrictions about specific versions I think I'd lean towards dropping the term "upgrade" altogether, to me "upgrade" implies that the process is potentially one way (i.e. increase version only), or perhaps could have rules like "only allowed to go by 1 major or minor version at a time" but as far as I know there are no restrictions on the versions, this tool could be used to go up or down to any version theoretically I think, so maybe just "Install" is a little more clear.

@makermelissa
Copy link
Collaborator

Yeah, makes sense. Perhaps a learn guide. As it is, I'm working on some features for a package that the code editor uses, that could also be beneficial to the installer here, so there will likely be some changes to make it work on more boards. But once that's all in place, it would make sense to write something with better documentation.

@FoamyGuy
Copy link
Contributor Author

The difference between is described in a comment here: #1440 (comment)

@jerryneedell
Copy link
Contributor

FYI - I just used the Installer for the first time on a few MagTags - These were MagTags that had not been used for quite some time and were way out of date. The Full Install worked perfectly. Thanks for this tool.

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

No branches or pull requests

3 participants