On Sep 10, 12:35 am, Tekkub <[email protected]> wrote:
> 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.
Of course. I'm not saying it needs to be a requirement. It's just a
heuristic to guess the format of a README file that lacks an
extension. In the cases you site, you will have to use an extension,
there would be no way guess the format anyway.
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
