Comment I was watching Max Howell talk about creating brew yesterday at FrenchKit. As part of his presentation, he made a great point about how important it was for open source projects to have great readme files and I couldn't agree with him more. As part of putting this newsletter together each week, I read a lot of readme files. As you might imagine, I have opinions on the subject. 😂 Creating a really great readme is hard and it takes more time and care than you might imagine. Does it start out by saying what the project actually does? You'd be surprised how many don't! Does it say how it will benefit the potential user? Does it spend more time talking about how to install it than it does saying how it will help you? If the library contains something visible, does it include a screenshot or two? If animation is important, are those screenshots presented as animated gifs? All of these things, and more are important. As part of the discussion that happened on Twitter, Tim Searle bravely volunteered the readme from his Euclid library for a public critique.


I guess you came to this post by searching similar kind of issues in any of the search engine and hope that this resolved your problem. If you find this tips useful, just drop a line below and share the link to others and who knows they might find it useful too.

Stay tuned to my blog, twitter or facebook to read more articles, tutorials, news, tips & tricks on various technology fields. Also Subscribe to our Newsletter with your Email ID to keep you updated on latest posts. We will send newsletter to your registered email address. We will not share your email address to anybody as we respect privacy.