Documentation is abysmal, please improve soon (or now)

[yh54321]

Issue / Feature - Horrible Documentation/Commentary FolioReader version - 5.13

FolioReader appears to be the most comprehensive, professionally built ePub reader source code currently available for free. I appreciate this project very much, clearly much thought and effort has been invested into its creation, and the chief contributors deserve much credit.

Unfortunately, the project cannot reach its full potential, given that the documentation and code commentary are perhaps the worst I have ever seen. I would very much like to further contribute to this repo, but the lack of necessary commentary increases coding time exponentially, causing me to give up on most of my efforts.

The issue can be broken down as follows:

• [ ] Little and Ineffective Code Commentary - Almost all the project source files are poorly commented on, or lack comments entirely. This creates a massive, unnecessary learning curve. Essentially everybody who intends to use this repo will attempt to modify/add to the code, and this problem alone will deter many from trying or lead to failure

• [ ] Lack of Useful Documentation - While I can appreciate the effort invested in the Readme and Wiki, they are clearly insufficient. Both are too short, and lack information needed to implement the software correctly. I just now noticed recent additions to the Wiki concerning new features, which gives me some hope.

• [x] No Latest Version/Update Notes - There is apparently no Latest Release page with past version histories. I literally have no idea what the newest version of the software is. This is particularly disappointing, given how simple it could be to resolve this issue. A release page should be created, showing past and latest versions of the software.

I believe these three areas should be given top priority. Improving on these issues will result in:

• Substantial increase in contributions and contributors
• Significant decrease in number of 'issues' opened (ridiculous number now)
• Vast developments in project features and scope
• Increased implementation of FolioReader
• Increase in credit and recognition to creators and contributors
• Many 100's of man-hours saved

Of course continually ignoring this issue simply makes it worse. Sadly, I believe that only a select few contributors currently have the knowledge required to address these problems. I request of you to reconsider your priorities with this project, and to reinvest your efforts into resolving this situation instead of furthering feature development.

[yh54321]

I notice new change log now that is better

[torralbaa]

I agree.