nedbat / scriv

Changelog management tool
https://scriv.readthedocs.io
Apache License 2.0
256 stars 28 forks source link

Update Installation Instructions in README.rst #99

Closed sderev closed 1 year ago

sderev commented 1 year ago

This pull request updates the installation instructions in README.rst to provide more detailed steps. Specifically, it adds instructions for installing the application using pipx.

Changes include:

These changes provide more complete instructions for installing the application, making it easier for new users to get started.

nedbat commented 1 year ago

I have two reservations about this:

1) If a project is using scriv, I would expect it to be installed as part of the project tooling, not as an application on the user's machine with pipx;

2) I'm torn about providing details of how to install and manage someone else's project (pipx). For example, I don't know what "ensurepath" does or why you need it.

sderev commented 1 year ago

Thanks for your feedback. I now see that I may have misunderstood the philosophy of scriv initially. While it might not necessitate the installation via pipx on every user's machine, my suggestion was aimed to ease the process for those wishing to use scriv independently.

As for pipx ensurepath, it ensures the pipx directory is in the user's PATH. This is a standard part of pipx's installation (https://pypa.github.io/pipx/), and without it, pipx may issue a warning.

I understand your concerns about including the details of another project's installation process within your README. My intention was simply to provide a short guide for those who might prefer this method of installation. I appreciate your viewpoint and respect your decision on this matter.