iText 7 readme review
amedee opened this issue · 2 comments
Feel free to have a go at the README.md
(and other .md
files) of iText:
https://github.com/itext/itext7
Some of the files have a very long history, which isn't reflected by the Git history, because they used to be .txt
files. Also, we used SVN in prehistoric times, see https://sourceforge.net/p/itext/code/HEAD/tree/trunk/itext/ (scheduled to be deleted)
Thank you, @amedee. I took a quick look at your README and suggest that you check out this template, then think about whether you want to adapt your copy to it in whole or in part:
https://github.com/zalando/zalando-howto-open-source/blob/master/READMEtemplate.md
And also please this project/product analysis template:
https://github.com/zalando/zalando-howto-open-source/blob/master/producttemplate.md
Because you have a website, you might decide to keep the README a little light on detailed information but simply use it to point to the website/relevant sections and sub-pages.
Do these things, then feel free to ping back and I'll take a look then!
I'll close this for now as it's been a while since hearing back.