Not at all... I for one usually don't use a header off the bat, I have an intro...
> Single paragraph intro goes here. It describes what the code does quickly > and simply. > h2. And then the details > Now we drill down... Sometimes I don't need headings at all, but I might use a bullet list, some links, and code or pre blocks. There's a lot of ways you can do your readme, leading with a heading certainly isn't a requirement. On Wed, Sep 9, 2009 at 10:20 PM, trans <[email protected]> wrote: > > > > On Sep 9, 10:45 pm, Tekkub <[email protected]> wrote: > > Ah but that's assuming the file begins with a header line, many don't. > > Ok, there's the case of Markdown underline headers, that should be > taken into account, but other than that, if there's no header wouldn't > that most likely mean the file is just text? I've looked through > dozens of projects and haven't found an exception yet. However I did > discover you support Restructured Text which would probably be > impossible to distinguish from Markdown. > > > P.S. Markdown extension can be .md and Restructured Text .rst, what > about .tt for textile? (And maybe .rd for RDoc, though .rdoc isn't so > bad.) > > > > --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "GitHub" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/github?hl=en -~----------~----~----~----~------~----~------~--~---
