Skip to content

Commit

Permalink
improve install instructions (github.com/Botspot/pi-apps/issues/2513)
Browse files Browse the repository at this point in the history
  • Loading branch information
l-koehler committed Jan 6, 2024
1 parent 7d62792 commit 094aea4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,23 @@ options, for example flipping the image or selecting codecs, in the tabs.
#### Installation
Install the `ffconverter` package from PyPI.
`pip` works on most distros and should be the simplest choice.

```sh
pip install ffconverter
```

#### Troubleshooting
On some distros (externally managed environments, Arch, Debian),
`pip` will not work. In this case, you should use `pipx`.

```sh
sudo PIPX_HOME=/usr/local/pipx PIPX_BIN_DIR=/usr/local/bin pipx install --system-site-packages ffconverter
sudo ln -sf /usr/local/pipx/venvs/ffconverter/share/applications/ffconverter.desktop /usr/local/share/applications/ffconverter.desktop
sudo ln -sf /usr/local/pipx/venvs/ffconverter/share/pixmaps/ffconverter.png /usr/local/share/icons/ffconverter.png
```
In some cases, the program might not appear in your installed applications, but
the `ffconverter` command will be available. In this case, run:
```sh
wget https://raw.githubusercontent.com/l-koehler/FF-converter/master/share/ffconverter.desktop -O ~/.local/share/applications/ffconverter.desktop
```
This command should add ffconverter to your installed applications, so you can
access the program without the terminal.

The last two commands are needed to add the program to your installed
applications, but the `ffconverter` command should be available without them.

#### Uninstall
Simply run:
Expand All @@ -53,6 +53,9 @@ Adjust this command if you used something other than `pip` to install.
#### Run without installing
You can launch the application without installing it
by running the launcher script:

```sh
python3 launcher
```
git clone https://github.com/l-koehler/ff-converter
cd ./ff-converter
python3 ./launcher
```
3 changes: 2 additions & 1 deletion share/ffconverter.desktop
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#!/usr/bin/env xdg-open
[Desktop Entry]
Type=Application
Version=2.0.1
Version=2.1.3
Name=FF Converter
GenericName=File Format Converter
GenericName[pt]=Conversor de ficheiros
Expand Down

0 comments on commit 094aea4

Please sign in to comment.