<br><br><div class="gmail_quote">On Wed, Feb 16, 2011 at 21:54, Fernando Perez <span dir="ltr"><<a href="http://fperez.net">fperez.net</a>@<a href="http://gmail.com">gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">

<div class="im">On Tue, Feb 15, 2011 at 10:38 AM, MinRK <<a href="mailto:benjaminrk@gmail.com">benjaminrk@gmail.com</a>> wrote:<br>
> The link is broken because GitHub doesn't support using '.txt' as a reST<br>
> extension, so it's interpreting the wrong text as a link.  We should<br>
> probably rename README.txt to README.rst, and link to the new doc page.<br>
> Is there a reason to *not* use .rst instead of .txt?<br>
<br>
</div>Well, docutils does suggest using txt as the reST extension, their<br>
argument being that they ultimately are text files.  And on more<br>
gui-oriented platforms, it was deemed as nicer for new users who could<br>
double-click on a .txt file and get automatically a text editor<br>
instead of a dialog about what application to use.  So historically,<br>
we went with txt.<br></blockquote><div><br></div><div>That makes sense.  Basic reST with headers, sections, emphasis and blocks is perfectly readable</div><div>as nicely formatted plaintext.  However, to me it seems like if you want a file to read</div>

<div>as plaintext as well as reST, you shouldn't use the markup that is less readable like `link text <<a href="http://hiddenlink.com">http://hiddenlink.com</a>>`_,</div><div>and you can use .rst as an extension when you do use the extended reST bits.</div>

<div><br></div><div>My vote:</div><div><br></div><div>either a) remove the hidden links for better .txt readability (and correct GH link parsing)</div><div>or b) rename to .rst so it looks nice on GitHub</div><div><br></div>

<div>I lean towards b), but if there really is a significant number of people who actually read READMEs but are foiled by a .rst extension, then we can stick to a).</div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">


<br>
But I have no strong feelings on the matter, so if you guys prefer to<br>
switch over to rst so the github setup is smoother, I won't oppose it<br>
in any way.<br>
<br>
Cheers,<br>
<font color="#888888"><br>
f<br>
</font></blockquote></div><br>