<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=0.8"/><title>---Read Me</title><link rel="stylesheet" type="text/css" href="scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="manual-style.css" title="default"/><link rel="stylesheet" type="text/css" href="manual-racket.css" title="default"/><script type="text/javascript" src="scribble-common.js"></script><script type="text/javascript" src="manual-racket.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><body id="scribble-racket-lang-org"><div class="tocset"><div class="tocview"><div class="tocviewlist tocviewlisttopspace"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">▼</a></td><td></td><td><a href="index.html" class="tocviewlink" data-pltdoc="x">Software Engineering</a></td></tr></table></div><div class="tocviewsublistonly" style="display: block;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right"></td><td><a href="abstract.html" class="tocviewlink" data-pltdoc="x">Reason</a></td></tr><tr><td align="right"></td><td><a href="general.html" class="tocviewlink" data-pltdoc="x">General</a></td></tr><tr><td align="right"></td><td><a href="lectures.html" class="tocviewlink" data-pltdoc="x">Lectures</a></td></tr><tr><td align="right"></td><td><a href="readings.html" class="tocviewlink" data-pltdoc="x">Readings</a></td></tr><tr><td align="right"></td><td><a href="communication.html" class="tocviewlink" data-pltdoc="x">Communicate</a></td></tr><tr><td align="right"></td><td><a href="lab.html" class="tocviewlink" data-pltdoc="x">Lab Book</a></td></tr><tr><td align="right"></td><td><a href="reviews.html" class="tocviewlink" data-pltdoc="x">In-<wbr></wbr>Class Reviews</a></td></tr><tr><td align="right"></td><td><a href="projects.html" class="tocviewlink" data-pltdoc="x">Assignments, Overview</a></td></tr><tr><td align="right"></td><td><a href="delivery.html" class="tocviewlink" data-pltdoc="x">—<wbr></wbr>Delivery</a></td></tr><tr><td align="right"></td><td><a href="make.html" class="tocviewlink" data-pltdoc="x">—<wbr></wbr>Make</a></td></tr><tr><td align="right"></td><td><a href="" class="tocviewselflink" data-pltdoc="x">—<wbr></wbr>Read Me</a></td></tr><tr><td align="right"></td><td><a href="testme.html" class="tocviewlink" data-pltdoc="x">—<wbr></wbr>Test Me</a></td></tr><tr><td align="right"></td><td><a href="debugging.html" class="tocviewlink" data-pltdoc="x">—<wbr></wbr>Debugging</a></td></tr><tr><td align="right"></td><td><a href="late.html" class="tocviewlink" data-pltdoc="x">—<wbr></wbr>Late Policy</a></td></tr><tr><td align="right"></td><td><a href="grades.html" class="tocviewlink" data-pltdoc="x">—<wbr></wbr>Code Grades</a></td></tr><tr><td align="right"></td><td><a href="projects2.html" class="tocviewlink" data-pltdoc="x">Assignments, Actual</a></td></tr><tr><td align="right"></td><td><a href="tahbpl.html" class="tocviewlink" data-pltdoc="x">—<wbr></wbr>TAHBPL</a></td></tr><tr><td align="right"></td><td><a href="assignments.html" class="tocviewlink" data-pltdoc="x">—<wbr></wbr>Project Milestones</a></td></tr></table></div></div></div></div><div class="maincolumn"><div class="main"><div class="versionbox"><span class="version">8.7</span></div><div class="navsettop"><span class="navleft"><div class="nosearchform"></div> <span class="tocsettoggle"> <a href="javascript:void(0);" title="show/hide table of contents" onclick="TocsetToggle();">contents</a></span></span><span class="navright"> <a href="make.html" title="backward to "---Make"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Software Engineering"" data-pltdoc="x">up</a> <a href="testme.html" title="forward to "---Test Me"" data-pltdoc="x">next →</a></span> </div><h3><a name="(part._readme)"></a>—<wbr></wbr>Read Me</h3><p><span class="refelem"><span class="refcolumn"><span class="refcontent"><img src="readme.png" alt="don't" width="52" height="38"/></span></span></span></p><p>Add a <span class="stt">README.md</span> file to the project directory. The first item in the file explains the overall purpose of the project. Extend the file with each weekly assignments to record your progress.</p><blockquote class="refpara"><blockquote class="refcolumn"><blockquote class="refcontent"><p>They do say that the best way to keep a secret on a computer is to place it in a file named <span class="stt">README</span>.</p></blockquote></blockquote></blockquote><p><div class="SIntrapara">In general, use the <span class="stt">README.md</span> to </div><div class="SIntrapara"><ul><li><p>state purpose of each folder and file in the directory;</p></li><li><p>sketch a roadmap base so that new maintainers can figure out how to navigate the repository. You may wish to use diagrams for this task to explain the relationship among the pieces, their interactions, etc;</p></li><li><p>demonstrate how to run the test harness for each milestone;</p></li><li><p>explain how to run the complete set of internal unit tests and the individual ones.</p></li></ul></div></p><p>The goal is to enable future maintainers to rapidly find their way around the code base, add unit tests for new bugs, fix a bug, or even add a feature—<wbr></wbr>without necessarily understanding the complete code base.</p><p>If you haven’t seen any good examples, <a href="https://github.com/matiassingers/awesome-readme#examples">take a look at these.</a></p><div class="navsetbottom"><span class="navleft"><div class="nosearchform"></div> <span class="tocsettoggle"> <a href="javascript:void(0);" title="show/hide table of contents" onclick="TocsetToggle();">contents</a></span></span><span class="navright"> <a href="make.html" title="backward to "---Make"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Software Engineering"" data-pltdoc="x">up</a> <a href="testme.html" title="forward to "---Test Me"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>