[Scons-dev] README in repository

William Deegan bill at baddogconsulting.com
Tue Oct 9 13:39:19 EDT 2012


Russel,


On Oct 9, 2012, at 9:22 AM, Russel Winder <russel at winder.org.uk> wrote:


> I think we have to take a vote on whether to switch the read me file at

> the top of the repository hierarchy from plain text to

>

> a) ReStructured Text, README.rst

> b) Markdown, README.md or README.markdown

>

> I have a slight preference fro Markdown due to the way it handles header

> markup compared to ReStructured Text. On the other hand Markdown is very

> Ruby, GitHub, whilst ReStructured Text is very Python.

>

> Why the change? So that the read me file look reasonable on the

> BitBucket page.

>

> I can do the markup once a decision is made so there is no need for

> anything other than a decision.


I vote for .rst (mainly because I'm already using it on a number of other projects and it's python'y)

-Bill


More information about the Scons-dev mailing list