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 Installation Instructions to README.md #22

Merged
merged 3 commits into from
Nov 5, 2022

Conversation

mikemhenry
Copy link
Contributor

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 use pipx so I can use it system wide and not worry about which conda env or python virtual env I have activated.

@mikemhenry
Copy link
Contributor Author

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.

@vsoch
Copy link
Owner

vsoch commented Nov 5, 2022

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.

@mikemhenry
Copy link
Contributor Author

I'm updating the PR with a better code snippet of the docs.

@vsoch
Copy link
Owner

vsoch commented Nov 5, 2022

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.

@mikemhenry
Copy link
Contributor Author

Ha! That was a copy and paste bug, I posted in another issue about action-lint (I installed the right tool IRL)

@mikemhenry
Copy link
Contributor Author

I also fixed a mistake in the link to the package on pypi in the docs

@mikemhenry
Copy link
Contributor Author

@vsoch ready for review!

@vsoch vsoch merged commit c44b33e into vsoch:main Nov 5, 2022
@vsoch
Copy link
Owner

vsoch commented Nov 5, 2022

Thank you @mikemhenry ! 🥳

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.

2 participants