aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 81f322f..26c3cd3 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,16 @@ Small PyQt6 app to upscale an image with an ESRGAN model through `sd-cli` (stabl
- PyQt6
- `sd-cli` from stable-diffusion.cpp, plus one or more ESRGAN upscaler models in a folder
+## Install
+
+Symlink the script and menu entry into your home directory, so later updates of the repo apply without reinstalling (`~/bin` must be on `PATH`):
+
+ ln -s "$PWD/upscale-qt" ~/bin/upscale-qt
+ ln -s "$PWD/upscale-qt.desktop" ~/.local/share/applications/upscale-qt.desktop
+ update-desktop-database ~/.local/share/applications
+
+The menu entry uses the `zoom-in` icon from your icon theme and registers for common image types, so "Open with" works from a file manager. To uninstall, remove the two symlinks.
+
## Usage
./upscale-qt [image]