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

Cleanup README, Move some instructions to docs/DEV.md #33

Merged
merged 3 commits into from
Oct 13, 2023
Merged

Conversation

liruilong940607
Copy link
Collaborator

@liruilong940607 liruilong940607 commented Oct 13, 2023

Also add a workflow for auto pypi. It will be triggered once we create a new release on main branch from here:

Screenshot 2023-10-12 at 7 00 12 PM

It assumes the repo has an environment called production and a secret token PYPI_TOKEN being setup in the repo setting. @vye16

And worth to note only @vye16 will be able to trigger this because it recognize her username and password, and the package will be uploaded to her PYPI project.

@liruilong940607 liruilong940607 changed the title Ruilong/readme Cleanup README, Move some instructions to docs/DEV.md Oct 13, 2023
@liruilong940607
Copy link
Collaborator Author

This is what the new README looks like:

Screenshot 2023-10-12 at 7 07 23 PM

Copy link
Collaborator

@vye16 vye16 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!

@maturk
Copy link
Collaborator

maturk commented Oct 13, 2023

LGTM! I was able to test pip install and source install, and it seems to work fine on my machine.

@maturk maturk merged commit 99bb8b6 into main Oct 13, 2023
2 checks passed
@liruilong940607 liruilong940607 deleted the ruilong/readme branch October 13, 2023 17:09
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.

3 participants