What goes in a README file


When composing a README file, the question to ask is: if someone you’ve never met were to clone your repo and investigate it, and they read your README file as a starting point, would they know what to do? I think at a minimum, you’d need to describe what your data set is, what each of the tables and columns means, and how to use pull_all.py and load.py.


Leave a Reply

Your email address will not be published. Required fields are marked *