2014-08-21 6:03 GMT+02:00 Stefan Bodewig <bode...@apache.org>: > On 2014-08-20, Benedikt Ritter wrote: > > > 2014-08-20 13:13 GMT+02:00 Stefan Bodewig <bode...@apache.org>: > > >> On 2014-08-20, Benedikt Ritter wrote: > > >>> I've committed a new mojo to the commons build plugin, which generates > a > >>> README.md file for a component [1]. > > >> Without looking at the code, do you plan to make it so that projects can > >> override the default README.md with a template of their own - much like > >> we currently allow for the download page? I can see myself wanting to > >> put more information there than the description from the POM at one > >> point in time. > > > That is possible? Didn't know that until now :o) > > I think so, yes. May be wrong. Please note this is not a showstopper, > though. Having those pages and generating them is a good idea. >
Hello Stefan, I've looked into the code again. I don't thing specifing a custom template is possible. In generate-xdocs.build.xml an ant javaresource is used to load the templates [1], so I think only templates that are packaged into the build plugin can be loaded. Can you confirm? > > > Anyway, the idea was to put only the most essential information into > > README.md and point people to the project's website, since I don't think > we > > should duplicate the information from the website in README.md... > > I agree with that. What I have in mind right now is telling people > which branch does what in case a project has multiple branches that may > be under development as branches are way more visible at github. Like > "master is for the current Foo 3.x releases while foo-2.x is for > the maintenance of the legacy 2.x releases. foo-1.x is no longer under > active development.". > Makes sense to me. Benedikt [1] http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml?view=markup > > Stefan > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > For additional commands, e-mail: dev-h...@commons.apache.org > > -- http://people.apache.org/~britter/ http://www.systemoutprintln.de/ http://twitter.com/BenediktRitter http://github.com/britter
