-
-
Notifications
You must be signed in to change notification settings - Fork 2
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 Installation Instructions to README.md #22
Conversation
Ah I see you have this documented quite well here: https://vsoch.github.io/action-updater/getting_started/installation.html#installation But I think that it is worth having some of this in the README, unless you want to try and get people to read the docs. |
Hey there! We have this instruction in the Installation section of our user guide: https://vsoch.github.io/action-updater/getting_started/installation.html#getting-started-installation. |
I'm updating the PR with a better code snippet of the docs. |
Ah gotcha, sure we could have a quick how to install there! I think you might want to double check the name of what you are installing though! See the docs I linked. |
Ha! That was a copy and paste bug, I posted in another issue about |
I also fixed a mistake in the link to the package on pypi in the docs |
@vsoch ready for review! |
Thank you @mikemhenry ! 🥳 |
I would be happy to add more, not sure if we want to mention using a virtual environment, or using
pipx
to install it. Personally for tools like this, I like to usepipx
so I can use it system wide and not worry about which conda env or python virtual env I have activated.