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 installation instructions for pipx (and other tidy-ups) #1166

Merged

Conversation

akrabat
Copy link
Member

@akrabat akrabat commented May 24, 2023

With the adoption of PEP 668, installation of applications such as rst2pdf with pip is discouraged and pipx is a better choice. Update our instructions to use pipx.

I also removed the Travis badge and renamed master to main in the README.

Finally, I've improved DEVELOPERS.rst to provide more comprehensive instructions for setting up rst2pdf for development with a venv and tidied up some other bits so that they are
more accurate/useful.

Fixes #1165

With the adoption of PEP 668, installation of applications such as
rst2pdf with pip is discouraged and pipx is a better choice. Update our
instructions to use pipx.
Remove Travis badge and use main branch name rather than master.
Provide more comprehensive instructions for setting up rst2pdf for
development with a venv. Also tidy various other bits so that they are
more accurate.
@akrabat akrabat requested a review from lornajane May 24, 2023 20:13
@akrabat akrabat added this to the 0.101 milestone May 24, 2023
Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

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

Thanks! I think you just about managed a patch longer than my original epic bug report!!

@lornajane lornajane merged commit 6315600 into rst2pdf:main Jul 9, 2023
4 checks passed
@akrabat akrabat deleted the 1165-update-installation-instructions branch August 2, 2023 18:39
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.

Installation instructions need updating for (at least) Debian/Ubuntu
2 participants