<p>You can make your <span class="caps">README</span> formatted by putting <span class="caps">README</span> with specific extension.</p> <h2>Supported Formats</h2> <table> <tr> <th>format </th> <th>extension </th> </tr> <tr> <td> <a href="http://rdoc.rubyforge.org/RDoc.html">rdoc</a> </td> <td> <span class="caps">README</span>.rdoc </td> </tr> <tr> <td> <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> </td> <td> <span class="caps">README</span>.markdown, <span class="caps">README</span>.md, <span class="caps">README</span>.mdown, <span class="caps">README</span>.mkd, <span class="caps">README</span>.mkdn</td> </tr> <tr> <td> <a href="http://hobix.com/textile/">Textile</a> </td> <td> <span class="caps">README</span>.textile </td> </tr> <tr> <td> <span class="caps">PNG</span> </td> <td> <span class="caps">README</span>.png (will display the image) </td> </tr> <tr> <td> <a href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> </td> <td> <span class="caps">README</span>.rst </td> </tr> <tr> <td> (no formatting) </td> <td> <span class="caps">README</span>.* (all but above extensions), <span class="caps">README</span> (no extension) </td> </tr> </table> <h2>Unsupported Formats</h2> <ul> <li>rd (<span class="caps">README</span>.rd)</li> <li>html (<span class="caps">README</span>.html &#8212; considered insecure)</li> </ul> <h2>Notes</h2> <ul> <li>If there is both <span class="caps">README</span> and <span class="caps">README</span>.foo, <span class="caps">README</span>.foo is displayed.</li> <li>feature request: <a href="http://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li> <li>feature request: <a href="http://en.wikipedia.org/wiki/Plain_Old_Documentation"><span class="caps">POD</span></a></li> <li>feature request: <a href="http://www.methods.co.nz/asciidoc/">AsciiDoc</a></li> <li>feature request: TiddlyWiki Syntax</li> <li>feature request: Something MediaWiki like such as <a href="http://mediacloth.rubyforge.org/">MediaCloth</a> or <a href="https://rubyforge.org/projects/wikicreole/">WikiCreole</a></li> <li>feature request: <a href="http://txt2tags.sourceforge.net">txt2tags</a></li> <li><strong>reStructuredText</strong>: there are certain, specific kinds of content that will cause the .rst renderer to fail. In particular, certain non-latin unicode glyphs will cause <span class="caps">README</span>.rst&#8217;s to not render on github while rendering perfectly happily using rst2html.py. If your <span class="caps">README</span>.rst will not render, try looking for unusual content in your .rst and stripping it out, and seeing if that has an effect.</li> </ul> 2008-07-03T00:13:34-07:00 54 readme-formatting 2009-11-05T20:17:11-08:00 83137