search

LappleApple / feedmereadmes

Free README editing+feedback to make your open source projects grow. See the README maturity model to help you keep going.
Creative Commons Attribution 4.0 International
1.13k stars 56 forks source link

iText 7 readme review #17

Closed amedee closed 6 years ago

amedee commented 7 years ago

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)

LappleApple commented 7 years ago

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!

LappleApple commented 6 years ago

I'll close this for now as it's been a while since hearing back.