1.1 --- a/documentation/readme.txt	Mon Nov 17 23:18:41 2014 +0100
     1.2 +++ b/documentation/readme.txt	Mon Nov 17 23:39:40 2014 +0100
     1.3 @@ -20,7 +20,59 @@
     1.4  the copy-image-resizer might be useful.
     1.5  
     1.6  
     1.7 -How?
     1.8 -----
     1.9 +Instalation
    1.10 +-----------
    1.11  
    1.12 +cd java/copy-image-resizer/
    1.13 +ant
    1.14  
    1.15 +compiled program is in: dist/copy-image-resizer.jar
    1.16 +
    1.17 +you can run it directly:
    1.18 +	java -jar dist/copy-image-resizer.jar
    1.19 +or install it somewhere and run through th wrapper script:
    1.20 +	scripts/copy-image-resizer.sh
    1.21 +(link it somewhere on your $PATH as „copy-image-resizer“)
    1.22 +
    1.23 +TODO: .rpm and .deb packages
    1.24 +
    1.25 +Usage
    1.26 +-----
    1.27 +
    1.28 +copy-image-resizer supports these options:
    1.29 +
    1.30 +--input-dir                 (mandatory)
    1.31 +	one parameter: path to the input directory
    1.32 +
    1.33 +--output-dir                (mandatory)
    1.34 +	one parameter: path to the output directory
    1.35 +
    1.36 +--size                      (mandatory, can be used multiple times to generate multiple resolutions)
    1.37 +	1. parameter: width          (integer)
    1.38 +	2. parameter: height         (integer)
    1.39 +	3. parameter: resizeSmaller  (boolean)    whether smaller images should be also scaled
    1.40 +
    1.41 +--size-named                (alternative to --size)
    1.42 +	1. parameter: width          (integer)
    1.43 +	2. parameter: height         (integer)
    1.44 +	3. parameter: resizeSmaller  (boolean)
    1.45 +	4. parameter: directory      (string)     output sub-directory for this resolution (default in --size is WIDTHxHEIGHT e.g. 64x64)
    1.46 +
    1.47 +--skip-errors               (optional, alternative to --skip-errors-silently)
    1.48 +	no parameters
    1.49 +	errors will be just logged and program will fail at the end if any errors
    1.50 +	(default behavior is: fail on first error)
    1.51 +
    1.52 +--skip-errors-silently      (optional, alternative to --skip-errors)
    1.53 +	no parameters
    1.54 +	errors will be just logged and program will report success even if there were any errors
    1.55 +
    1.56 +
    1.57 +
    1.58 +Example:
    1.59 +
    1.60 +copy-image-resizer --input-dir MyPhotos/ --output-dir MyBlog/ --size 800 600 false --size 1600 1200 false --size-named 300 300 false thumnails
    1.61 +
    1.62 +Will generate three output resolutions in separate directories: „MyBlog/800x600“, „MyBlog/1600x1200“ and „MyBlog/thumbnails“
    1.63 +
    1.64 +