CARVIEW |
Select Language
HTTP/2 302
server: nginx
date: Wed, 23 Jul 2025 20:42:56 GMT
content-type: text/plain; charset=utf-8
content-length: 0
x-archive-redirect-reason: found capture at 20081225182313
location: https://web.archive.org/web/20081225182313/https://github.com/guides/readme-formatting.atom
server-timing: captures_list;dur=1.062045, exclusion.robots;dur=0.031224, exclusion.robots.policy;dur=0.013269, esindex;dur=0.014720, cdx.remote;dur=85.176904, LoadShardBlock;dur=251.127597, PetaboxLoader3.datanode;dur=112.770902, PetaboxLoader3.resolve;dur=97.725132
x-app-server: wwwb-app215
x-ts: 302
x-tr: 446
server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0
set-cookie: SERVER=wwwb-app215; path=/
x-location: All
x-rl: 0
x-na: 0
x-page-cache: MISS
server-timing: MISS
x-nid: DigitalOcean
referrer-policy: no-referrer-when-downgrade
permissions-policy: interest-cohort=()
HTTP/2 200
server: nginx
date: Wed, 23 Jul 2025 20:42:57 GMT
content-type: application/atom+xml; charset=utf-8
content-length: 26717
x-archive-orig-server: nginx/0.6.26
x-archive-orig-date: Thu, 25 Dec 2008 18:23:13 GMT
x-archive-orig-connection: close
x-archive-orig-status: 200 OK
x-archive-orig-x-runtime: 129ms
x-archive-orig-etag: "80208ab74f60e4221e1a7d0b038e4ed2"
x-archive-orig-cache-control: private, max-age=0, must-revalidate
x-archive-orig-content-length: 26717
cache-control: max-age=1800
x-archive-guessed-content-type: text/xml
x-archive-guessed-charset: utf-8
memento-datetime: Thu, 25 Dec 2008 18:23:13 GMT
link: ; rel="original", ; rel="timemap"; type="application/link-format", ; rel="timegate", ; rel="first memento"; datetime="Thu, 25 Dec 2008 18:23:13 GMT", ; rel="memento"; datetime="Thu, 25 Dec 2008 18:23:13 GMT", ; rel="last memento"; datetime="Thu, 25 Dec 2008 18:23:13 GMT"
content-security-policy: default-src 'self' 'unsafe-eval' 'unsafe-inline' data: blob: archive.org web.archive.org web-static.archive.org wayback-api.archive.org athena.archive.org analytics.archive.org pragma.archivelab.org wwwb-events.archive.org
x-archive-src: 52_7_20081225142019_crawl103-c/52_7_20081225182225_crawl103.arc.gz
server-timing: captures_list;dur=0.772199, exclusion.robots;dur=0.031898, exclusion.robots.policy;dur=0.014152, esindex;dur=0.014041, cdx.remote;dur=155.478865, LoadShardBlock;dur=515.289251, PetaboxLoader3.datanode;dur=408.981012, PetaboxLoader3.resolve;dur=333.050909, load_resource;dur=262.984008
x-app-server: wwwb-app215
x-ts: 200
x-tr: 993
server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0
x-location: All
x-rl: 0
x-na: 0
x-page-cache: MISS
server-timing: MISS
x-nid: DigitalOcean
referrer-policy: no-referrer-when-downgrade
permissions-policy: interest-cohort=()
accept-ranges: bytes
tag:github.com,2008:/guides/readme-formatting
GitHub Guides - README Formatting
2008-11-04T15:16:40-08:00
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-11-04T15:16:40-08:00
README Formatting - version 11
Tue Nov 04 15:16:40 -0800 2008
<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> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> <a href="https://daringfireball.net/projects/markdown/syntax">Markdown</a> </td>
<td> README.markdown, <span class="caps">README</span>.md, <span class="caps">README</span>.mkdn, <span class="caps">README</span>.mdown</td>
</tr>
<tr>
<td> <a href="https://hobix.com/textile/">Textile</a> </td>
<td> README.textile </td>
</tr>
<tr>
<td> PNG </td>
<td> README.png (will display the image) </td>
</tr>
<tr>
<td> <a href="https://docutils.sourceforge.net/rst.html">reStructuredText</a> </td>
<td> README.rst </td>
</tr>
<tr>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
<h2>Unsupported Formats</h2>
<ul>
<li>rd (README.rd)</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="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</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’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>
idangazit
idan@pixane.net
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-09-21T12:10:20-07:00
README Formatting - version 10
Sun Sep 21 12:10:20 -0700 2008
<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> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> <a href="https://daringfireball.net/projects/markdown/syntax">Markdown</a> </td>
<td> README.markdown, <span class="caps">README</span>.md, <span class="caps">README</span>.mkdn, <span class="caps">README</span>.mdown</td>
</tr>
<tr>
<td> <a href="https://hobix.com/textile/">Textile</a> </td>
<td> README.textile </td>
</tr>
<tr>
<td> PNG </td>
<td> README.png (will display the image) </td>
</tr>
<tr>
<td> <a href="https://docutils.sourceforge.net/rst.html">reStructuredText</a> </td>
<td> README.rst </td>
</tr>
<tr>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
<h2>Unsupported Formats</h2>
<ul>
<li>rd (README.rd)</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="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li>
</ul>
tekkub
tekkub@gmail.com
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-08-19T12:58:54-07:00
README Formatting - version 9
Tue Aug 19 12:58:54 -0700 2008
<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> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> <a href="https://daringfireball.net/projects/markdown/syntax">Markdown</a> </td>
<td> README.markdown, <span class="caps">README</span>.md, <span class="caps">README</span>.mkdn </td>
</tr>
<tr>
<td> <a href="https://hobix.com/textile/">Textile</a> </td>
<td> README.textile </td>
</tr>
<tr>
<td> PNG </td>
<td> README.png (will display the image) </td>
</tr>
<tr>
<td> <a href="https://docutils.sourceforge.net/rst.html">reStructuredText</a> </td>
<td> README.rst </td>
</tr>
<tr>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
<h2>Unsupported Formats</h2>
<ul>
<li>rd (README.rd)</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="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li>
</ul>
dylanm
dylanm@umich.edu
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-08-18T13:04:30-07:00
README Formatting - version 8
Mon Aug 18 13:04:30 -0700 2008
<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> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> Markdown </td>
<td> README.markdown, <span class="caps">README</span>.md, <span class="caps">README</span>.mkdn </td>
</tr>
<tr>
<td> <a href="https://hobix.com/textile/">Textile</a> </td>
<td> README.textile </td>
</tr>
<tr>
<td> PNG </td>
<td> README.png (will display the image) </td>
</tr>
<tr>
<td> <a href="https://docutils.sourceforge.net/rst.html">reStructuredText</a> </td>
<td> README.rst </td>
</tr>
<tr>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
<h2>Unsupported Formats</h2>
<ul>
<li>rd (README.rd)</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="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li>
</ul>
tekkub
tekkub@gmail.com
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-08-09T06:22:57-07:00
README Formatting - version 7
Sat Aug 09 06:22:57 -0700 2008
<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> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> Markdown </td>
<td> README.markdown, <span class="caps">README</span>.md, <span class="caps">README</span>.mkdn </td>
</tr>
<tr>
<td> Textile </td>
<td> README.textile </td>
</tr>
<tr>
<td> PNG </td>
<td> README.png (will display the image) </td>
</tr>
<tr>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
<p>Found more? Please add to the table.</p>
<h2>Unsupported Formats</h2>
<ul>
<li>rd (README.rd)</li>
<li>reStructuredText (README.rst)</li>
</ul>
<h2>Note</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="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li>
<li>feature request: <a href="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/321-add-support-for-restructuredtext-formated-readme-files">Add support for reStructuredText</a></li>
</ul>
jezdez
jannis@leidel.info
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-08-09T06:22:17-07:00
README Formatting - version 6
Sat Aug 09 06:22:17 -0700 2008
<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> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> Markdown </td>
<td> README.markdown, <span class="caps">README</span>.md, <span class="caps">README</span>.mkdn </td>
</tr>
<tr>
<td> Textile </td>
<td> README.textile </td>
</tr>
<tr>
<td> PNG </td>
<td> README.png (will display the image) </td>
</tr>
<tr>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
<p>Found more? Please add to the table.</p>
<h2>Unsupported Formats</h2>
<ul>
<li>rd (README.rd)</li>
<li>rST (README.rst)</li>
</ul>
<h2>Note</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="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li>
<li>feature request: <a href="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/321-add-support-for-restructuredtext-formated-readme-files">Add support for reStructuredText</a></li>
</ul>
jezdez
jannis@leidel.info
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-08-02T20:37:13-07:00
README Formatting - version 5
Sat Aug 02 20:37:13 -0700 2008
<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> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> Markdown </td>
<td> README.markdown, <span class="caps">README</span>.md, <span class="caps">README</span>.mkdn </td>
</tr>
<tr>
<td> Textile </td>
<td> README.textile </td>
</tr>
<tr>
<td> PNG </td>
<td> README.png (will display the image) </td>
</tr>
<tr>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
<p>Found more? Please add to the table.</p>
<h2>Unsupported Formats</h2>
<ul>
<li>rd (README.rd)</li>
</ul>
<h2>Note</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="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li>
</ul>
tapajos
tapajos@improveit.com.br
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-07-12T18:13:30-07:00
README Formatting - version 4
Sat Jul 12 18:13:30 -0700 2008
<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> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> Markdown </td>
<td> README.markdown, <span class="caps">README</span>.md </td>
</tr>
<tr>
<td> Textile </td>
<td> README.textile </td>
</tr>
<tr>
<td> PNG </td>
<td> README.png (will display the image) </td>
</tr>
<tr>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
<p>Found more? Please add to the table.</p>
<h2>Unsupported Formats</h2>
<ul>
<li>rd (README.rd)</li>
</ul>
<h2>Note</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="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li>
</ul>
celtic
celtic@sairyx.org
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-07-03T00:18:51-07:00
README Formatting - version 3
Thu Jul 03 00:18:51 -0700 2008
<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> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> Markdown </td>
<td> README.markdown, <span class="caps">README</span>.md </td>
</tr>
<tr>
<td> Textile </td>
<td> README.textile </td>
</tr>
<tr>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
<p>Found more? Please add to the table.</p>
<h2>Unsupported Formats</h2>
<ul>
<li>rd (README.rd)</li>
</ul>
<h2>Note</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>Do not put <span class="caps">README</span>.png: binary data will be dumped in <span class="caps">ASCII</span>.
<ul>
<li>see also: https://logicalawesome.lighthouseapp.com/projects/8570/tickets/609-readme-png</li>
</ul>
</li>
<li>feature request: <a href="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li>
</ul>
yhara
yutaka.hara+github@gmail.com
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-07-03T00:15:40-07:00
README Formatting - version 2
Thu Jul 03 00:15:40 -0700 2008
<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> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> Markdown </td>
<td> README.markdown, <span class="caps">README</span>.md </td>
</tr>
<tr>
<td> Textile </td>
<td> README.textile </td>
</tr>
<tr>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
<p>Found more? Please add to the table.</p>
<h2>Unsupported Formats</h2>
<ul>
<li>rd (README.rd)</li>
</ul>
<h2>Note</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>Do not put <span class="caps">README</span>.png: binary data will be dumped in <span class="caps">ASCII</span>.
* see also: https://logicalawesome.lighthouseapp.com/projects/8570/tickets/609-readme-png</li>
<li>feature request: <a href="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li>
</ul>
yhara
yutaka.hara+github@gmail.com
tag:github.com,2008:Guide/54
2008-07-03T00:13:34-07:00
2008-07-03T00:13:34-07:00
README Formatting - version 1
Thu Jul 03 00:13:34 -0700 2008
<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
<table>
<tr>
<th>format </th>
<th>extension </th>
</tr>
<tr>
<td> rdoc </td>
<td> README.rdoc </td>
</tr>
<tr>
<td> Markdown </td>
<td> README.markdown, <span class="caps">README</span>.md </td>
</tr>
<tr>
<td> Textile </td>
<td> README.textile </td>
<td> (no formatting) </td>
<td> README.* (all but above extensions), <span class="caps">README</span> (no extension) </td>
</tr>
</table>
</h2>
<p>Found more? Please add to the table.</p>
<h2>Unsupported Formats
<ul>
<li>rd (README.rd)</li>
</ul></h2>
<h2>Note
<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>Do not put <span class="caps">README</span>.png: binary data will be dumped in <span class="caps">ASCII</span>.
* see also: https://logicalawesome.lighthouseapp.com/projects/8570/tickets/609-readme-png</li>
<li>feature request: <a href="https://logicalawesome.lighthouseapp.com/projects/8570/tickets/38-format-readmes-without-an-extension"> format READMEs without an extension</a></li>
</ul></h2>
yhara
yutaka.hara+github@gmail.com