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

Documentation: Advertise pipx for program installation (PEP 668) #451

Merged
merged 1 commit into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,20 +45,16 @@ Installation
Python Package
--------------

Crash is available as a `pip`_ package.
Crash is available as a package from PyPI.

To install, run::
To install the most recent version, run::

pip install crash
pipx install --upgrade crash

Now, run it::

crash

To update, run::

pip install -U crash

Standalone
----------

Expand Down
12 changes: 3 additions & 9 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,20 @@ Installation
Python package
--------------

Crash is available as a `pip`_ package.
Crash is available as a package from PyPI.

To install, run:
To install the most recent version, run:

.. code-block:: console

sh$ pip install crash
sh$ pipx install --upgrade crash

Now, run it:

.. code-block:: console

sh$ crash

To update, run:

.. code-block:: console

sh$ pip install -U crash

Standalone
----------

Expand Down