Skip to content

Installation instructions for pipx should include instructions for invocation #1178

@bismurphy

Description

@bismurphy
Is your feature request related to a problem?

On the front page of this repo, it suggests pipx install urh, and says "This is the recommended way to install URH on Linux because it comes with all native extensions precompiled."

However, after doing this, it is not clear how to launch/invoke URH on the machine it has been installed on.

Describe the solution you'd like

The same Readme should say "After installing through pipx (and potentially adjusting your udev rules), URH can be started by..."

Describe alternatives you've considered

Anything that would indicate to a fresh installer how to launch URH. Is it as simple as running urh in the terminal? Is it invoked with a python -m urh or something? The installation instruction is clear; the launching is not. In the "Running from source" section the instructions finish by launching (main.py on Windows, urh on Linux), but there is nothing for the basic pipx installation.

Additional context

I installed URH on Linux Mint 22 by using the pipx instruction, and then guessed I could launch URH by running urh in the terminal, but that didn't work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions