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

update release documentation to use twine (because otherwise didnt work for me) #73

Merged
merged 3 commits into from
Jun 8, 2021

Conversation

catstavi
Copy link
Contributor

@catstavi catstavi commented Jun 8, 2021

No description provided.

@catstavi catstavi force-pushed the cmu/update-release-documentation branch from 9b1b927 to c7734eb Compare June 8, 2021 17:29
@catstavi catstavi requested a review from vickingan June 8, 2021 17:30
README.md Outdated
@@ -526,11 +526,33 @@ make docs
```

## Releasing
release to pypi by bumping the version to something reasonable and running
You will need to have twine installed, and a `.pypirc` file in your home directory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do we install twine?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pip3 install twine -- I can update it to say "with pip" ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to say "with pip3 install twine" as an easy installation instruction!

Copy link
Contributor

@vickingan vickingan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 Looks great

@catstavi catstavi merged commit 7c35e72 into master Jun 8, 2021
@catstavi catstavi deleted the cmu/update-release-documentation branch June 8, 2021 19:02
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

2 participants