{"id":156,"date":"2026-09-04T14:21:44","date_gmt":"2026-09-04T14:21:44","guid":{"rendered":"https:\/\/stephendavies.org\/data419\/?p=156"},"modified":"2026-09-04T14:21:44","modified_gmt":"2026-09-04T14:21:44","slug":"what-goes-in-a-readme-file","status":"publish","type":"post","link":"https:\/\/stephendavies.org\/data419\/index.php\/2026\/09\/04\/what-goes-in-a-readme-file\/","title":{"rendered":"What goes in a README file"},"content":{"rendered":"<p>When composing a README file, the question to ask is: if someone you&#8217;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&#8217;d need to describe what your data set is, what each of the tables and columns means, and how to use <tt>pull_all.py<\/tt> and <tt>load.py<\/tt>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>When composing a README file, the question to ask is: if someone you&#8217;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&#8217;d need to describe what your data set is, what each [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":"","_links_to":"","_links_to_target":""},"categories":[1],"tags":[],"class_list":["post-156","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/stephendavies.org\/data419\/index.php\/wp-json\/wp\/v2\/posts\/156","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/stephendavies.org\/data419\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/stephendavies.org\/data419\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/stephendavies.org\/data419\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/stephendavies.org\/data419\/index.php\/wp-json\/wp\/v2\/comments?post=156"}],"version-history":[{"count":1,"href":"https:\/\/stephendavies.org\/data419\/index.php\/wp-json\/wp\/v2\/posts\/156\/revisions"}],"predecessor-version":[{"id":157,"href":"https:\/\/stephendavies.org\/data419\/index.php\/wp-json\/wp\/v2\/posts\/156\/revisions\/157"}],"wp:attachment":[{"href":"https:\/\/stephendavies.org\/data419\/index.php\/wp-json\/wp\/v2\/media?parent=156"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/stephendavies.org\/data419\/index.php\/wp-json\/wp\/v2\/categories?post=156"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/stephendavies.org\/data419\/index.php\/wp-json\/wp\/v2\/tags?post=156"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}