commit a7ca6ddc1b6fe75f01d99eba6c2b345911244814
parent b59d111b236b06a8aecaa63571ad667fab4572f1
Author: René Wagner <rwagner@rw-net.de>
Date: Sun, 19 Jul 2020 12:31:05 +0200
update README.md
Diffstat:
1 file changed, 17 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
@@ -8,6 +8,19 @@ For convenience there are also prebuilt executables attached to every [snapshot]
Maybe there will be packages for installation on different systems later on.
+# usage
+All scripts are commandline / shell tools which should run on \*n\*x and Windows when the prerequistes are met.
+
+For information about parameters and usage call `script(.pl) --help`.
+Whether you need to use the `.pl` extension depends on if you are using the pure scripts or the binary distribution.
+
+## binary executables
+I provide binary executables for x86_64 linux and Arch Linux packages, you can download at https://git.sr.ht/~rwa/photo-helpers/refs.
+
+## bare scripts
+Simply clone the repo or manually download the scripts from https://git.sr.ht/~rwa/photo-helpers/.
+To run a script, open a shell and invoke `perl script.pl`, on most systems it should be sufficient to just invoke `script.pl` (after you granted execute-permissions to the script).
+
### Prerequisites for running the pure scripts
- Perl 5.30 (or newer)
@@ -22,25 +35,18 @@ Additionally the following perl modules need to be installed:
- File::Find
- File::Spec::Functions
-# usage
-All scripts are commandline / shell tools which should run on \*n\*x and Windows when the prerequistes are met.
-
-To run a script, open a shell and invoke `perl script.pl`, on most systems it should be sufficient to just invoke `script.pl`.
-
-For information about parameters and usage call `script.pl --help`.
-
# ART helper scripts
Helper scripts to manage files which where handled by [ART](https://clttr.info/art).
## processed file mover
-Filename: `afm.pl`
+Filename: `afm(.pl)`
Moves all already converted raw files and their corresponding jpegs to a given folder.
# generic scripts
## JpegDivider
-Filename: `jd.pl`
+Filename: `jd(.pl)`
Moves all jpeg files (suffixes .jpg and .jpeg) in a folder to the subfolder JPEG (or a given subfolder).
@@ -63,11 +69,11 @@ base folder
```
## orphaned sidecar cleaner
-Filename: `sposc.pl`
+Filename: `sposc(.pl)`
Deletes all sidecar files in the given directory or alternatively in the current working directory when the associated raw file is missing.
## multiversion sidecar cleaner
-Filename: `spmvsc.pl`
+Filename: `spmvsc(.pl)`
Deletes Silkypix Sidecar files when newer versions of the files are available. This usually happens when a file is opened in a newer version of Silkypix, as the sidecar files are version specific.
