Browse code

update repo and file names

René Wagner authored on 30.12.2019 11:48:39
Showing 4 changed files

... ...
@@ -1,8 +1,13 @@
1
-# Silkypix Helper Scripts
2
-This rather small scripts written in [Perl](https://perl.org) provide useful function for managing the sidecar data files created by [Silkypix Developer Studio](https://silkypix.isl.co.jp/en/).
1
+# About
2
+This rather small scripts written in [Perl](https://perl.org) provide useful function for managing 
3 3
 
4 4
 For bug reports or feature requests please visit [our bugtracker](https://tracker.codewolke.net).
5 5
 
6
+# Prerequisites
7
+
8
+- Perl 5.30 (or newer)
9
+- Exiftool
10
+
6 11
 ## required perl modules
7 12
 The following perl modules are required for running the scripts.
8 13
 
... ...
@@ -14,13 +19,28 @@ The following perl modules are required for running the scripts.
14 19
 - File::Spec::Functions
15 20
 - Switch
16 21
 
17
-## description
22
+# usage
23
+All scripts are commandline / shell tools which should run on *n*x and Windows when the prerequistes are met.
24
+
25
+To run a script, open a shell and invoke `perl script.pl`, on most systems it should be sufficient to just invoke `script.pl`.
26
+
27
+For information about parameters and usage call `script.pl -h` 
18 28
 
19
-### jpeg divider
29
+# generic scripts
30
+
31
+## jpeg divider
32
+Filename: `jpegdivider.pl`
20 33
 Moves all jpeg files (suffixes .jpg and .jpeg) in a folder to the subfolder JPEG.
21 34
 
22
-### orphaned sidecar cleaner
35
+# Silkypix helper scripts
36
+Helper scripts to manage the sidecar data files created by [Silkypix Developer Studio](https://silkypix.isl.co.jp/en/).
37
+
38
+## orphaned sidecar cleaner
39
+Filename: `silkypix_orphaned_sidecar_cleaner.pl`
40
+
23 41
 Deletes all sidecar files in the given directory or alternatively in the current working directory when the associated raw file is missing.
24 42
 
25
-### multiversion sidecar cleaner
43
+## multiversion sidecar cleaner 
44
+Filename: `silkypix_multiversion_sidecar_cleaner.pl`
45
+
26 46
 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.
... ...
@@ -1,7 +1,7 @@
1 1
 #!/usr/bin/perl
2 2
 # Copyright(c) René Wagner 2019
3 3
 # published under BSD 3-Clause License
4
-# https://www.codewolke.net/silkypix-helper/
4
+# https://www.codewolke.net/photo-helpers/
5 5
 
6 6
 use warnings;
7 7
 use strict;
... ...
@@ -81,7 +81,7 @@ sub show_help
81 81
 	say $PROGRAM . ' - version ' . $VERSION;
82 82
 	say 'published under BSD 3 - Clause License';
83 83
 	say 'Copyright(c) 2019 René Wagner';
84
-	say 'https://www.codewolke.net/silkypix-helper/';
84
+	say 'https://www.codewolke.net/photo-helpers/';
85 85
 	say '';
86 86
 	say 'Moves JPEG files to a designated subfolder, by default "JPEG"';
87 87
 	say '';
88 88
similarity index 96%
89 89
rename from multiversion_sidecar_cleaner.pl
90 90
rename to silkypix_multiversion_sidecar_cleaner.pl
... ...
@@ -1,7 +1,7 @@
1 1
 #!/usr/bin/perl
2 2
 # Copyright(c) René Wagner 2019
3 3
 # published under BSD 3-Clause License
4
-# https://www.codewolke.net/silkypix-helper/
4
+# https://www.codewolke.net/photo-helpers/
5 5
 
6 6
 use warnings;
7 7
 use strict;
... ...
@@ -108,7 +108,7 @@ sub show_help
108 108
 	say $PROGRAM . ' - version ' . $VERSION;
109 109
 	say 'published under BSD 3 - Clause License';
110 110
 	say 'Copyright(c) 2019 René Wagner';
111
-	say 'https://www.codewolke.net/silkypix-helper/';
111
+	say 'https://www.codewolke.net/photo-helpers/';
112 112
 	say '';
113 113
 	say 'Deletes Silkypix Sidecar files when newer versions of the files are available.';
114 114
 	say 'This usually happens when a file is opened in a newer version of Silkypix, as the sidecar files are version specific.';
115 115
similarity index 96%
116 116
rename from orphaned_sidecar_cleaner.pl
117 117
rename to silkypix_orphaned_sidecar_cleaner.pl
... ...
@@ -1,7 +1,7 @@
1 1
 #!/usr/bin/perl
2 2
 # Copyright(c) René Wagner 2019
3 3
 # published under BSD 3-Clause License
4
-# https://www.codewolke.net/silkypix-helper/
4
+# https://www.codewolke.net/photo-helpers/
5 5
 
6 6
 use warnings;
7 7
 use strict;
... ...
@@ -90,7 +90,7 @@ sub show_help
90 90
 	say $PROGRAM . ' - version ' . $VERSION;
91 91
 	say 'published under BSD 3 - Clause License';
92 92
 	say 'Copyright(c) 2019 René Wagner';
93
-	say 'https://www.codewolke.net/silkypix-helper/ ';
93
+	say 'https://www.codewolke.net/photo-helpers/';
94 94
 	say '';
95 95
 	say 'Deletes Silkypix Sidecar files when corresponding RAW files are missing.';
96 96
 	say '';