README file

[priit....@gmail.com]

Hi gitorious people!

What do you think if we automatically append (or some other ways
highlight README file) at Project Overview page?

For background: I might overuse git repositories :-). For example I'm
pushing my small openid wrapper [1] to three different repositories at
the moment: gitorious.org (main one for sure :-), rubyforge.org and
github.com.

So that's why I really like to update README file itself and not
Project Overview page separately.

Moreover it is most convenient for me to update README file and do
"git push" than to login web interface and update etc.

What others think about to give more love to README file at Project
Overview page?

Cheers,
priit.mx.ee

[1] http://gitorious.org/projects/openid-wrapper

[Jorge Calás Lozano]

I would really second that if it doesn't imply having lot of different,
formats and extensions (.rdoc, .markdown, .textile, .html, etc) in the
different projects.

Why to use textile or markdown in my README file? Does Rdoc (for ruby
projects) know how to handle those formats when generating the "serious"
project documentation?

I vote for supporting just plain text and rdoc markup. And process it as
rdoc does, so what we get is just the same we get when rdoc
documentation is generated for the project (with gem, with rake task or
whatever).

But... what about non-ruby projects? Really don't know, maybe support
other kind of markup too, but what I don't like is having a markup in
the readme file that will only be usefull when in git(hub|orious) and
not in the project documentation that other lot of people should read,
not necessarily using a browser in gitorious.

Just ideas on what I don't like in github while loving the feature
itself.

Jorge