schnaader / fairytale

encode.ru community archiver
GNU Lesser General Public License v3.0
31 stars 13 forks source link

Documentation Improvements Fairytale #34

Open aravipati1 opened 9 months ago

aravipati1 commented 9 months ago

Detailed Description(what should change, what did change): With Fairytale, I made significant improvements to the documentation to make it more informative and straightforward for users to follow and build on. The documentation lacked proper detailed instructions on how to use it and its features so I made sure to list out all its features and made it clear to users how to build it in Windows and Linux. Additionally, I added three new sections to the documentation. The documentation lacked user quality of life features that would help readability and applicability significantly. Firstly, I added a usage section that gave users tips on how to compress, decompress, and configure compression options with Fairytale. Next, I added performance tips to advise users for a smoother experience. It is important that users are aware of certain issues and limitations that might impede on their experience. Therefore, the final section I added listed the known issues and limitations to make sure users look out for those errors.