DEV Community

Discussion on: How to Document your repository in GitHub?

Collapse
 
geraldew profile image
geraldew

Very glad to see you including "prerequisites" as something to always have in a README. I'd also suggest adding something about clearly stating the implementation programming language. As someone who works in a very constrained environment, the requirement to install any extra interpreter/compiler immediately rules out a candidate codebase.

Thus for every single project I look at, the first thing I need to be sure about is "what is this written in?" You would think that is very easy to just state in the README and yet this is rarely done.

Collapse
 
taimoorsattar7 profile image
Taimoor Sattar

It is good practice to mention prerequisites in README.

Collapse
 
geraldew profile image
geraldew

I frequently see various "prerequisites" quoted with no mention at all of the language(s) the code is written in. Sorry if I didn't make that clear.