|
<p>== README</p>
<p>This README would normally document whatever steps are necessary to get the
application up and running.</p>
<p>Things you may want to cover:</p>
<ul>
<li><p>Ruby version</p></li>
<li><p>System dependencies</p></li>
<li><p>Configuration</p></li>
<li><p>Database creation</p></li>
<li><p>Database initialization</p></li>
<li><p>How to run the test suite</p></li>
<li><p>Services (job queues, cache servers, search engines, etc.)</p></li>
<li><p>Deployment instructions</p></li>
<li><p>...</p></li>
</ul>
<p>Please feel free to use a different markup language if you do not plan to run
<tt>rake doc:app</tt>.</p>
|