Some command line options are not GNU/POSIX compliant (3)
[geeqie.git] / README.md
index 931586d..6d37e30 100644 (file)
--- a/README.md
+++ b/README.md
@@ -120,13 +120,34 @@ The Continuous Build release version has AppImages that are automatically genera
 
 The minimal version can display jpegs, pngs and some other formats, but does not have the range of the full version.
 
-This script file will download the latest Continuous Build AppImages for you:
+This script file will download to $HOME/bin the latest Continuous Build AppImages for you:
 
 ```sh
-wget https://github.com/BestImageViewer/geeqie/blob/master/scripts/geeqie-download-appimage.sh
+wget https://raw.githubusercontent.com/BestImageViewer/geeqie/master/scripts/geeqie-download-appimage.sh
 chmod +x geeqie-download-appimage.sh
 ```
 
+The script can download either the full size or the minimal version of the AppIamge, and sets a symbolic link to the executable file. The ```--help``` option lists all options.
+
+The full version takes a noticeable time to load, and runs slightly slower than a normal packaged release.
+The above script has the option ```--extract``` which extracts the contents of either AppImage to a sub-directory under $HOME/bin.
+With this option the loading and run time is the same as for a packaged release.
+
+There are also options to install desktop icons, menu items, and to revert to earlier downloaded versions.
+
+AppImages have a "portable mode" which is described [here](https://docs.appimage.org/user-guide/portable-mode.html).
+
+**Note:**
+
+Command line auto-completion does not work with AppImages. If you are using the AppImage `--extract` option, this is a work-around.
+
+Assuming you have extracted the AppImage to `$HOME/bin/Geeqie-latest-x86_64-AppImage/`, create a symbolic link as follows:
+
+```sh
+mkdir --parents $HOME/.local/share/bash-completion/completions/
+ln --symbolic $HOME/bin/Geeqie-latest-x86_64-AppImage/squashfs-root/usr/local/share/bash-completion/completions/geeqie $HOME/.local/share/bash-completion/completions/geeqie
+```
+
 ### Installation scripts
 
 Geeqie is stable and you may compile the latest version from sources.
@@ -151,9 +172,7 @@ chmod +x geeqie-install-debian.sh
 
 If you wish to compile the sources yourself you may download the latest version (if you have installed git) from here:
 
-Either: `git clone git://git.geeqie.org/geeqie.git`
-
-Or: `git clone http://git.geeqie.org/git/geeqie.git`
+`git clone http://git.geeqie.org/git/geeqie.git`
 
 ### Compiling and Installing