Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct typos and improve help info #200

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

Mikachu2333
Copy link
Collaborator

@Mikachu2333 Mikachu2333 commented Mar 30, 2024

  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 Mikachu2333 self-assigned this Mar 30, 2024
@Mikachu2333 Mikachu2333 marked this pull request as draft March 30, 2024 17:42
@Mikachu2333
Copy link
Collaborator Author

Mikachu2333 commented Mar 30, 2024

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?

@SalOne22
Copy link
Owner

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.

@Mikachu2333
Copy link
Collaborator Author

Mikachu2333 commented May 5, 2024

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.

@SalOne22
Copy link
Owner

To update - added support for TIFF decoding

@Mikachu2333
Copy link
Collaborator Author

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.

@SalOne22
Copy link
Owner

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.

@Mikachu2333
Copy link
Collaborator Author

I haven't added support for TIFF encoding.

OK, i'll correct that

@Mikachu2333
Copy link
Collaborator Author

Mikachu2333 commented Aug 20, 2024

#263 Should be added to this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants