# HG changeset patch
# User František Kučera <franta-hg@frantovo.cz>
# Date 1416263980 -3600
# Node ID 4e4ad30c17d43ff2412d73a74dfbeb4c78ba4567
# Parent  cda20970564291cbf9632ccc7a7b5d94542a7786
documentation – readme

diff -r cda209705642 -r 4e4ad30c17d4 documentation/readme.txt
--- a/documentation/readme.txt	Mon Nov 17 23:18:41 2014 +0100
+++ b/documentation/readme.txt	Mon Nov 17 23:39:40 2014 +0100
@@ -20,7 +20,59 @@
 the copy-image-resizer might be useful.
 
 
-How?
-----
+Instalation
+-----------
 
+cd java/copy-image-resizer/
+ant
 
+compiled program is in: dist/copy-image-resizer.jar
+
+you can run it directly:
+	java -jar dist/copy-image-resizer.jar
+or install it somewhere and run through th wrapper script:
+	scripts/copy-image-resizer.sh
+(link it somewhere on your $PATH as „copy-image-resizer“)
+
+TODO: .rpm and .deb packages
+
+Usage
+-----
+
+copy-image-resizer supports these options:
+
+--input-dir                 (mandatory)
+	one parameter: path to the input directory
+
+--output-dir                (mandatory)
+	one parameter: path to the output directory
+
+--size                      (mandatory, can be used multiple times to generate multiple resolutions)
+	1. parameter: width          (integer)
+	2. parameter: height         (integer)
+	3. parameter: resizeSmaller  (boolean)    whether smaller images should be also scaled
+
+--size-named                (alternative to --size)
+	1. parameter: width          (integer)
+	2. parameter: height         (integer)
+	3. parameter: resizeSmaller  (boolean)
+	4. parameter: directory      (string)     output sub-directory for this resolution (default in --size is WIDTHxHEIGHT e.g. 64x64)
+
+--skip-errors               (optional, alternative to --skip-errors-silently)
+	no parameters
+	errors will be just logged and program will fail at the end if any errors
+	(default behavior is: fail on first error)
+
+--skip-errors-silently      (optional, alternative to --skip-errors)
+	no parameters
+	errors will be just logged and program will report success even if there were any errors
+
+
+
+Example:
+
+copy-image-resizer --input-dir MyPhotos/ --output-dir MyBlog/ --size 800 600 false --size 1600 1200 false --size-named 300 300 false thumnails
+
+Will generate three output resolutions in separate directories: „MyBlog/800x600“, „MyBlog/1600x1200“ and „MyBlog/thumbnails“
+
+