rimage icon indicating copy to clipboard operation
rimage copied to clipboard

docs: correct typos and improve help info

Open Mikachu2333 opened this issue 1 year ago • 8 comments

  1. Correct typos By default rimage will place output images right in place of **precious** images, resulting in overwrite if input and output has the same format, could not understand the word "precious" and suspect that it should be "previous" (But still difficult to understand what the word "previous" mean, the input pic's dir or the folder for outputting images when using rimage last time?)
  2. Change some sentences to become simpler to understand
  3. Correct has the same format to has the same file extension name, e.g. pic with jxl or jpegxl file ext name has the same format and same codec.
  4. Add some examples and recommand infos.
  5. Change sh code mark to powershell for better color when display the commands

In progress

Mikachu2333 avatar Mar 30 '24 17:03 Mikachu2333

Do you think that the new section of "Detailed Examples" should be merged into the section "Basic optimization suitable for file transfer on web"? @SalOne22

Or is it necessary to merge all scattered examples into one large chapter?

Mikachu2333 avatar Mar 30 '24 18:03 Mikachu2333

Do you think that the new section of "Detailed Examples" should be merged into the section "Basic optimization suitable for file transfer on web"?

I think this should be a separate section.

Also take a look at the hyperfine repo for a great Usage section example.

SalOne22 avatar Mar 30 '24 18:03 SalOne22

Need to add infos about icc tags and new args about --preserve. Besides, maybe we need to add msgs about what rimage would do in each codecs when contains icc tag.

Mikachu2333 avatar May 05 '24 13:05 Mikachu2333

To update - added support for TIFF decoding

SalOne22 avatar Jul 13 '24 11:07 SalOne22

Because the TIFF format has not yet been added in .\cli\codecs\tiff.rs, I've not been able to add relevant explanations in the README.md yet.

In addition, I worte the package tiff as the encoder and decoder of TIFF format in README.md and please verify if it is correct. And I want to know if there are any other additional features for TIFF, such as only allowing lossless output, etc.

Mikachu2333 avatar Jul 24 '24 15:07 Mikachu2333

Because the TIFF format has not yet been added in .\cli\codecs\tiff.rs, I've not been able to add relevant explanations in the README.md yet.

I haven't added support for TIFF encoding. This requires implementing the Seek trait for the Writer, and I haven't figured out how to do that yet.

SalOne22 avatar Jul 25 '24 16:07 SalOne22

I haven't added support for TIFF encoding.

OK, i'll correct that

Mikachu2333 avatar Jul 25 '24 16:07 Mikachu2333

#263 Should be added to this.

Mikachu2333 avatar Aug 20 '24 13:08 Mikachu2333