search

tukaani-project / xz-java

XZ for Java
https://tukaani.org/xz/java.html
BSD Zero Clause License
23 stars 14 forks source link

Update README #17

Closed JNightRider closed 2 months ago

JNightRider commented 2 months ago

Hello XZ!

I've been testing xz for java and it's very good, but I feel like the help files on github are a bit flat (project).

This PR formats the README (main) file to implement Markdown.

[ Before ] Captura desde 2024-07-06 14-05-17

[ After ] Captura desde 2024-07-06 14-09-44

What do you think of this small change?

Larhzu commented 2 months ago

Thanks! I really like to keep the plain text look optimized for readability instead of editability. That way people who read the files without a Markdown renderer have a nicer experience, I hope.

I have converted most of the plain text files to Markdown now (they should be strictly CommonMark compliant). There was a Markdown PR in XZ Utils too but I won't do such a conversion there for now.