commit e67991692cfa1d809ed3a0deb9c8f8eaafa03566
parent a48297fd35bff54c91156ce9f8f72d9bcb0a69d3
Author: René Wagner <rwagner@rw-net.de>
Date: Sat, 23 May 2020 19:15:44 +0200
update README.md
Diffstat:
1 file changed, 10 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
@@ -1,14 +1,18 @@
# About
This rather small scripts written in [Perl](https://perl.org) provide useful function for managing (raw and output) files for photographers.
-# Prerequisites
+## How to get
+You can simply grab the pure perl scripts from the [repo](https://git.sr.ht/~rwa/photo-helpers/) and run them on your system. Make sure that your systems meets the prerequisites listed below.
-- Perl 5.30 (or newer)
-- Exiftool
+For convenience there are also prebuilt executables attached to every [snapshot](https://git.sr.ht/~rwa/photo-helpers/refs). Make sure to get the executables that match your system / architecture.
+
+Maybe there will be packages for installation on different systems later on.
-## required perl modules
-The following perl modules are required for running the scripts.
+### Prerequisites for running the pure scripts
+
+- Perl 5.30 (or newer)
+Additionally the following perl modules need to be installed:
- Cwd
- File::HomeDir
- File::Basename
@@ -20,7 +24,7 @@ The following perl modules are required for running the scripts.
# 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/commandline and invoke `perl script.pl`, on most systems it should be sufficient to just invoke `script.pl`.
+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`.