Another thought I had about this is to provide 2-3 examples of build files. Instead of one large-ish build, maybe start with a very minimal build such as compiling and packaging a jar. Then progress to more involved examples such as building a war, then an ear. The simple build on the front page, then link to the more complex examples with explanations.
my 2 cents. -Shane On Mon, Oct 5, 2009 at 12:06 AM, Paul Hammant <[email protected]> wrote: > Another idea would be to take a well known open source project in Ant (or > Maven) and show the build script for the same. This way, readers could > click off to the original XML, or see (inlined) the equivalent Buildr > > I'd suggest this one - > http://svn.apache.org/viewvc/commons/proper/math/trunk/build.xml?view=markup > > Regards, > > -Paul Hammant > [ Apache Member > [email protected] ] > > On Oct 4, 2009, at 10:51 PM, Daniel Spiewak wrote: > >> I'm not really sure that's the best example. Buildr's build requirements >> are quite unique, and while the buildfile linked is very concise, it's >> also >> not very informative. I think that we should instead go with a contrived >> example showing a main project in Java with WAR packaging, along with >> subprojects in Scala and Groovy (and maybe one in Java, just for >> completeness). It should also have a small custom task. >> >> One slight problem with this is Buildr infers so much from the directory >> structure that you really don't get the whole picture with just a >> buildfile. Maybe there's some sneaky graphical way to superimpose the >> buildfile contents over the directory structure... >> >> Daniel >> >> On Sun, Oct 4, 2009 at 7:01 PM, Paul Hammant <[email protected]> wrote: >> >>> I'm thinking such a script should be on the home page, and also on the >>>>> >>>>> getting started page. >>>>> >>>>> >>>> +1 >>>> >>>> Even better if it's the buildfile of an actual open source project, so >>>> you >>>> can experience it. >>>> >>> >>> Better yet, if it is a dogfood script .. >>> >>> http://svn.apache.org/repos/asf/buildr/trunk/buildr.buildfile ?? >>> >>> I prefer curly brackets though to do/end for pseudo-declarative scripts >>> such as this. >>> >>> I'm involved with the Swiby project at Codehaus and for the views at >>> least >>> { } is right - >>> http://svn.codehaus.org/swiby/trunk/core/demo/banking/banking.rb >>> That's for Views, for Models and Controllers we go back to do/end as that >>> is classic Ruby scripts. >>> As it happens the Swiby front page does not have the example script that >>> I'm preaching to you guys as essential. I'll fix that shortly. >>> >>> -Paul Hammant >>> [ Apache Member >>> [email protected] ] >>> >>> > >
