If you insist on using some sort of markup without an extension, why not use Markdown? It degrades very nicely to plain text and remains highly readable. Also keep in mind that people often view the README from a shell after cloning the repository or downloading a package, not just on the Github website. So a simple, readable format may be preferable anyway.
-Mirko On Oct 15, 7:09 am, John Barnette <[email protected]> wrote: > On Thu, Oct 15, 2009 at 4:51 AM, trans <[email protected]> wrote: > > == Why do I care? > > > I do not like putting extensions on my projects top document files > > (README, HISTORY, COPYING) . I have only done so in cases to appease > > how GitHub functions. But it's not nice to be forced into something to > > appease a development tool. I realize sometimes that is inescapable, > > but when possible the development tool should conform to how > > developers work, not the other way round. And for decades developers > > have been creating README files with no extensions. > > I felt this way too for a while, but I eventually decided that if the > contents of my metafiles (README, CHANGELOG, etc.) use some actual > markup language (I use RDoc, for example) they deserve an extension. > > I think GitHub does a fine job of displaying README files with no > extension. They're rendered as plain text, which is what developers > have been putting in them for decades. > > ~ j. --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
