Request: Document what the `--strict` option does

fhanau / Efficient-Compression-Tool

Fast and effective C++ file optimizer

Apache License 2.0

596 stars 41 forks source link

Request: Document what the `--strict` option does #127

Open louie-github opened 1 year ago

louie-github commented 1 year ago

From what I have learned by skimming through some issues and asking around, using --strict does these things:

Keep pixel values of completely transparent alpha channels in PNG files
Do not recursively optimize ZIP files

Is there anything else this option does? I think it would be useful to document it somewhere, either in the README or in the help string.

Additionally, as a side note, you should probably add --help as an option to ECT.

Thank you!

fhanau commented 1 year ago

That's about it – the only other thing is refusing to process gzip files that contain metadata (comment or extra field) which would be removed otherwise. I'll look into documenting this better. For ECT's help interface, run the program with no arguments, -h or -help.