https://www.thinkulum.net/w/index.php?action=history&feed=atom&title=Software_Development%2FREADMEs 2026-04-23T11:32:06Z Revision history for this page on the wiki MediaWiki 1.37.1 https://www.thinkulum.net/w/index.php?title=Software_Development/READMEs&diff=389&oldid=prev 2019-02-22T05:47:59Z

<p>Added the article.</p> <p><b>New page</b></p><div>Here's a recommendation of what to put in a README:<br /> <br /> * [http://www.writethedocs.org/guide/writing/beginners-guide-to-docs/ A beginner’s guide to writing documentation - Write the Docs]<br /> <br /> Here are some example READMEs that have helped me plan mine:<br /> <br /> * [https://gist.github.com/jxson/1784669 jxson/README.md]<br /> * [https://gist.github.com/PurpleBooth/109311bb0361f32d87a2 PurpleBooth/README-Template.md]<br /> * [https://gist.github.com/zenorocha/4526327 zenorocha/README.md]<br /> <br /> Here are some other lists of READMEs:<br /> <br /> * [https://changelog.com/posts/a-beginners-guide-to-creating-a-readme A Beginner's Guide to Creating a README]<br /> * [https://github.com/matiassingers/awesome-readme matiassingers/awesome-readme]<br /> * [https://github.com/repat/README-template repat/README-template]<br /> <br /> The initial README I came up with is [https://github.com/thinkulum/math-student-sim/blob/master/README.md here].<br /> <br /> [[Category:Programming]]<br /> [[Category:Essays]]<br /> [[Category:Developing]]</div>

Andy Culbertson