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

Add Instructions for upgrading ScubaGoggles #424

Open
1 task
adhilto opened this issue Sep 19, 2024 · 0 comments · May be fixed by #425
Open
1 task

Add Instructions for upgrading ScubaGoggles #424

adhilto opened this issue Sep 19, 2024 · 0 comments · May be fixed by #425
Assignees
Labels
documentation This issue or pull request improves or adds to documentation
Milestone

Comments

@adhilto
Copy link
Collaborator

adhilto commented Sep 19, 2024

💡 Summary

Add instructions to the README for how to upgrade ScubaGoggles.

Motivation and context

Users may need help upgrading from older releases to the latest.
 

Implementation notes

  • Say a user downloaded the ScubaGoggles code when v0.2 was released by cloning the repo (as opposed to downloading the release), then used pip install . When v0.3 is released, if all they do is pull the latest from main, scubagoggles gws will break.
  • If a user takes the route of downloading the release zip, how do they upgrade scubaggogles to the latest release? (it should be as simple as running python -m pip install . from the newly downloaded folder, but it might be useful to state that).

Acceptance criteria

  • Documentation has been updated
@adhilto adhilto added the documentation This issue or pull request improves or adds to documentation label Sep 19, 2024
@adhilto adhilto added this to the Coast milestone Sep 19, 2024
@adhilto adhilto self-assigned this Sep 19, 2024
@adhilto adhilto linked a pull request Sep 19, 2024 that will close this issue
14 tasks
@adhilto adhilto linked a pull request Sep 19, 2024 that will close this issue
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant