Better README.md
This commit is contained in:
parent
12f485cf0e
commit
faed062297
29
README.md
29
README.md
|
@ -22,6 +22,35 @@
|
|||
###### COMPILATION
|
||||
See INSTALL.md for more details.
|
||||
|
||||
----------
|
||||
|
||||
###### COMMAND LINE ARGUMENTS
|
||||
- `-q, --quality [value]` {Required}
|
||||
Sets the quality of the image. The higher the value is, better the result will be. Note that a value of 0 will mean
|
||||
_lossless_ compression, which will not modify the original image, but will compress less. Allowed range is [0. 100].
|
||||
A common value for lossy compression is 80.
|
||||
- `-e, --exif`
|
||||
Keeps the JPEG metadata information during compression. File size will be slightly higher.
|
||||
- `-o, --output [value]` {Required}
|
||||
Path to the output folder where the compressed files will be stored. Can be the same input folder, which will overwrite the original files.
|
||||
- `-s, --scale [value]`
|
||||
Will scale the image to a factor of _[value]_. Allowed formats are decimal values, fractions and percentages.
|
||||
The factor must be a number > 0 and <= 1.0, as caesiumclt won't upscale any image.
|
||||
_This is an experimental feature and might not work as expected._
|
||||
- `-R, --recursive`
|
||||
If the input is a folder, caesiumclt will also scan every subfolder searching for images.
|
||||
Note that this may end up building a large set of files to be compressed and should be used carefully.
|
||||
- `-S, --keep-structure`
|
||||
If the input is a folder, and the `-R` option is set, caesiumclt will compress all the files keeping the original folder structure.
|
||||
- `-d, --dry-run`
|
||||
If this option is set, no files will be compressed, but the entire process will just be simulated.
|
||||
Useful for checking if all the files will be correctly handled.
|
||||
- `-h, --help`
|
||||
Displays a summary of the command line arguments, much like this one you're reading.
|
||||
- `-v, --version`
|
||||
Prints the current caesiumclt version.
|
||||
|
||||
|
||||
----------
|
||||
|
||||
###### USAGE EXAMPLES
|
||||
|
|
Loading…
Reference in New Issue