buildr 1.3.5-x86-mswin32

data/doc/building.textile

@@ -0,0 +1,244 @@
+---
+layout: default
+title: Building
+---
+
+
+To remove any confusion, Buildr's build task is actually called @build@.  It's also the default task that executes when you run @buildr@ without any task name.
+
+The @build@ task runs two other tasks: @compile@ and its associated tasks (that would be, @resources@) and @test@ and its associated tasks (@test:compile@, @test:setup@ and friends).  We'll talk about @compile@ more in this section, and @test@ later on.  We'll also show you how to run @build@ without testing, not something we recommend, but a necessary feature.
+
+Why @build@ and not @compile@?  Some projects do more than just compiling. Other projects don't compile at all, but perform other build tasks, for example, creating a database schema or command line scripts.  So we want you to get in the practice of running the @build@ task, and help you by making it the default task.
+
+
+h2(#compiling). Compiling
+
+Each project has its own @compile@ task you can invoke directly, by running @buildr compile@ or as part of another build task.  (Yes, that @build@).
+
+The @compile@ task looks for source files in well known directories, determines which compiler to use, and sets the target directory accordingly.  For example, if it finds any Java source files in the @src/main/java@ directory, it selects the Javac compiler and generates bytecode in the @target/classes@ directories. If it finds Scala source files in the @src/main/scala@ directory it selects the Scalac compiler, and so forth.
+
+A single project cannot use multiple compilers at the same time, hence you may  prefer creating subprojects by programming language.  Some compilers like Groovy's are joint-compilers, this means they can handle several languages. When the Groovy compiler is selected for a project, .groovy  and .java files are compiled by groovyc.
+
+Most often, that's just good enough and the only change you need to make is adding compile dependencies.  You can use @compile.dependencies@ to get the array of dependency file tasks.  For Java, each of these tasks points to a JAR or a directory containing Java classes, and the entire set of dependencies is passed to Javac as the classpath.
+
+Buildr uses file tasks to handle dependencies, but here we're talking about the Rake dependency mechanism.  It's a double entendre.  It invokes these tasks before running the compiler.  Some of these tasks will download JARs from remote repositories, others will create them by compiling and packaging from a different project.  Using file task ensures all the dependencies exist before the compiler can use them.
+
+An easier way to specify dependencies is by calling the @compile.with@ method. It takes a list of arguments and adds them to the dependency list.  The @compile.with@ method is easier to use, it accepts several type of dependencies.  You can use file names, file tasks, projects, artifacts specifications and even pass arrays of dependencies.
+
+Most dependencies fall into the last three categories.  When you pass a project to @compile.with@, it picks up all the packages created by that project.  In doing so, it establishes an order of dependency between the two projects (see "Defining the Project":projects.html#defining).  For example, if you make a change in project _teh-api_ and build _teh-impl_, Buildr will detect that change, recompile and package _teh-api_ before compiling _teh-impl_.  You can also select a specific package using the @package@ or @packages@ methods (see "Packaging":packaging.html).
+
+When you pass an artifact specification to @compile.with@, it creates an @Artifact@ task that will download that artifact from one of the remote repositories, install it in the local repository, and use it in your project. Rake's dependency mechanism is used here to make sure the artifact is downloaded once, when needed.  Check the "Artifacts":artifacts.html section for more information about artifact specification and repositories.
+
+For now let's just show a simple example:
+
+{% highlight ruby %}
+compile.with 'org.apache.axis2:axis2:jar:1.2',
+  'org.apache.derby:derby:jar:10.1.2.1', projects('teh-api', 'teh-impl')
+{% endhighlight %}
+
+Passing arrays to @compile.with@ is just a convenient for handling multiple dependencies, we'll show more examples of that when we talk about "Artifacts":artifacts.html.
+
+Likewise, the @compile@ task has an array of file tasks that point at the source directories you want to compile from.  You can access that array by calling @compile.sources@.  You can use @compile.from@ to add new source directories by passing a file name or a file task.
+
+For example, let's run the APT tool on our annotated source code before compiling it:
+
+{% highlight ruby %}
+compile.from apt
+{% endhighlight %}
+
+When you call @apt@ on a project, it returns a file task that points to the @target/generated/apt@ directory.  This file task executes by running APT, using the same list of source directories, dependencies and compiler options. It then generates new source files in the target directory.  Calling @compile.from@ with that file task includes those additional source files in the list of compiled sources.
+
+Here's another example:
+
+{% highlight ruby %}
+jjtree = jjtree(_('src/main/jjtree'), :in_package=>'com.acme')
+compile.from javacc(jjtree, :in_package=>'com.acme'), jjtree
+{% endhighlight %}
+
+This time, the variable @jjtree@ is a file task that reads a JJTree source file from the @src/main/jjtree@ directory, and generates additional source files in the @target/generated/jjtree@ directory.  The second line creates another file task that takes those source files, runs JavaCC on them, and generates yet more source files in @target/generated/javacc@.  Finally, we include both sets of source files in addition to those already in @src/main/java@, and compile the lot.
+
+The interesting thing about these two examples is how you're wiring file tasks together to create more complicated tasks, piping the output of one task into the inputs of another.  Wiring tasks this way is the most common way to handle complex builds, and uses Rake's dependency mechanism to only run tasks when it detects a change to one of the source files.
+
+You can also control the target directory.  Use @compile.target@ to get the target directory file task.  If you need to change the target directory, call the @compile.into@ method with the new path.
+
+We use method pairs to give you finer control over the compiler, but also a way to easily configure it.  Methods like @dependencies@ and @sources@ give you a live array you can manipulate, or iterate over.  On the other hand, methods like @with@ and @from@ accept a wider set of arguments and clean them up for you.  They also all return the same task you're calling, so you can chain methods together.
+
+For example:
+
+{% highlight ruby %}
+compile.from('srcs').with('org.apache.axis2:axis2:jar:1.2').
+  into('classes').using(:target=>'1.4')
+{% endhighlight %}
+
+Buildr uses the method pair and method chaining idiom in many places to make your life easier without sacrificing flexibility.
+
+Occasionally, you'll need to post-process the generated bytecode.  Since you only want to do that after compiling, and let the compiler decide when to do that – only when changes require re-compiling – you'll want to extend the @compile@ task.  You can do that by calling @compile@ with a block.
+
+For example, to run the OpenJPA bytecode enhancer after compiling the source files:
+
+{% highlight ruby %}
+compile { open_jpa_enhance }
+{% endhighlight %}
+
+You can change various compile options by calling, you guessed, @compile.options@.  For example, to set the compiler to VM compatibility with Java 1.5 and turn on all Lint messages:
+
+{% highlight ruby %}
+compile.options.target = '1.5'
+compile.options.lint = 'all'
+{% endhighlight %}
+
+Or, if you want to chain methods together:
+
+{% highlight ruby %}
+compile.using :target=>'1.5', :lint=>'all'
+{% endhighlight %}
+
+
+Sub-projects inherit compile options from their parent project, so you only need to change these settings once in the top project.  You can do so, even if the top project itself doesn't compile anything.
+
+The options available to you depend on which compiler you are using for this particular project, obviously the options are not the same for Java and Flash. Two options are designed to work consistently across compilers.
+
+Buildr turns the @warning@ option on by default, but turns it off when you run @buildr --silent@.  It also sets the @debug@ option on, but turns it off when making a release.  You can also control the @debug@ option from the command line, for example:
+
+{% highlight ruby %}
+# When calling buildr
+$ buildr compile debug=off
+
+# Once until we change the variable
+$ export DEBUG=off
+$ buildr compile
+{% endhighlight %}
+
+The default source and target directories, compiler settings and other options you can use depend on the specific language.  You can find more information in the "Languages":languages.html section.
+
+
+h2(#resources). Resources
+
+
+The @compile@ task comes bundled with a @resources@ task.  It copies files from the @src/main/resources@ directory into @target/resources@.  Best used for copying files that you want to included in the generated code, like configuration files, i18n messages, images, etc.
+
+The @resources@ task uses a filter that can change files as it copies them from source to destination.  The most common use is by mapping values using a hash. For example, to substitute "${version}" for the project's version number and "${copyright}" for "Acme Inc (C) 2007" :
+
+{% highlight ruby %}
+resources.filter.using 'version'=>version,
+  'copyright'=>'Acme Inc (C) 2007'
+{% endhighlight %}
+
+You can also use "profiles":settings_profiles.html#profiles to supply a name/value map that all @resources@ task should default to, by adding a @filter@ element to each of the profiles.  The following examples shows a @profiles.yaml@ file that applies the same filter in development and test environments:
+
+{% highlight yaml %}
+filter: &alpha1
+  version: experimental
+  copyright: Acme Inc (C) 2007
+  
+development:
+  filter: *alpha1
+test:
+  filter: *alpha1
+{% endhighlight %}
+
+You can specify a different format by passing it as the first argument. Supported formats include:
+
+|_. Format  |_. Usage |
+| @:ant@    | Map from @key@ to value. |
+| @:maven@  | Map from @${key}@ to value (default). |
+| @:ruby@   | Map from @#{key}@ to value. |
+| @Regexp@  | Map using the matched value of the regular expression (e.g. @/=(.*?)=/@). |
+
+For example, using the @:ruby@ format instead of the default @:maven@ format:
+
+{% highlight ruby %}
+resources.filter.using :ruby, 'version'=>version,
+  'copyright'=>'Acme Inc (C) 2007'
+{% endhighlight %}
+
+For more complicated mapping you can also pass a method or a proc.  The filter will call it once for each file with the file name and content.
+
+If you need to copy resource files from other directories, add these source directories by calling the @from@ method, for example:
+
+{% highlight ruby %}
+resources.from _('src/etc')
+{% endhighlight %}
+
+You can select to copy only specific files using common file matching patterns. For example, to include only HTML files:
+
+{% highlight ruby %}
+resources.include '*.html'
+{% endhighlight %}
+
+To include all files, except for files in the @scratch@ directory:
+
+{% highlight ruby %}
+resources.exclude 'scratch/*'
+{% endhighlight %}
+
+The filter always excludes the @CVS@ and @.svn@ directories, and all files ending with @.bak@ or @~@, so no need to worry about these.
+
+A file pattern can match any file name or part of a file name using an asterisk (@*@).  Double asterisk (@**@) matches directories recursively, for example, @'src/main/java/**/*.java'@.  You can match any character using a question mark (@?@), or a set of characters using square brackets (@[]@), similar to regular expressions, for example, @'[Rr]eadme'@. You can also match from a set of names using curly braces (@{}@), for example, @'*.{html,css}'@.
+
+You can use filters elsewhere.  The @filter@ method creates a filter, the @into@ method sets the target directory, and @using@ specifies the mapping. Last, you call @run@ on the filter to activate it.
+
+For example:
+
+{% highlight ruby %}
+filter('src/specs').into('target/specs').
+  using('version'=>version, 'created'=>Time.now).run
+{% endhighlight %}
+
+The @resources@ task is, in fact, just a wrapper around such a filter that automatically adds the @src/main/resources@ directory as one of the source directories.
+
+
+h2(#more). More On Building
+
+The @build@ task runs the @compile@ (and @resources@) tasks as prerequisites, followed by any actions you add to it, and completes by running the @test@ task.  The @build@ task itself is a prerequisite to other tasks, for example, @package@ and @upload@.
+
+You can extend the @build@ task in two ways.  You can add more prerequisites that will execute before the task itself, or you can add actions that will execute as part of the task.  Which one you choose is up to you, we'll show you how they differ in a second.  If you call @build@ with a list of tasks, it adds these tasks as prerequisites.  Call @build@ with a block, and it adds that block as an action.  Again, a common idiom you'll see elsewhere in Buildr and Rake.
+
+Let's look at a simple example.  Say we want to generate a Derby database from an SQL file and include it in the ZIP package:
+
+{% highlight ruby %}
+db = Derby.create(_('target/derby/db')=>_('src/main/sql/derby.sql'))
+package(:zip).include db
+{% endhighlight %}
+
+There's nothing fundamentally wrong with this code, if that's what you intend to do.  But in practice, you don't always run the @package@ task during development, so you won't notice if something is wrong with this task when you build.  For example, if it fails to generate the SQL file.  In addition, the @package@ task runs after @build@, so you can't use the database in your test cases.
+
+So let's refactor it.  We're going to use the variable @db@ to reference the file task that creates the database, and make it a prerequisite of the @build@ task.  And use that same variable again to include the database in the ZIP package:
+
+{% highlight ruby %}
+db = Derby.create(_('target/derby/db')=>_('src/main/sql/derby.sql'))
+build db
+package(:zip).include db
+{% endhighlight %}
+
+Much better.  We're using the same task twice, but since we're using Rake here, it will only execute once.  In fact, it will only execute if we don't already have a Derby database, or if it detects a change to the SQL file and needs to recreate the database.
+
+p(tip). @Derby.create@ is not part of Buildr, you can get "derby.rake":http://svn.apache.org/repos/asf/ode/trunk/tasks/derby.rake here.
+
+Here's another example.  We want to copy some files over as part of the build, and apply a filter to them.  This time, we're going to extend the @build@ task:
+
+{% highlight ruby %}
+build do
+  filter('src/specs').into('target/specs').
+    using('version'=>version, 'created'=>Time.now).run
+end
+{% endhighlight %}
+
+The @build@ task is recursive, so running @buildr build@ picks the current project and runs its @build@ task, which in turn runs the @build@ task on each of its sub-projects.  One @build@ task to rule them all.
+
+
+h2(#cleaning). Cleaning
+
+The @build@ task has an evil twin, the @clean@ task.  It's the task you use to remove all the files created during the build, especially when you mess things up and want to start all over.
+
+It basically erases the target directories, the one called @target@, and if you get creative and change the target directory for tasks like @compile@, it will also erase those.  If you decide to generate files outside the target directory and want to cleanup after yourself, just extend the @clean@ task.
+
+For example: 
+
+{% highlight ruby %}
+clean { rm_rf _('staged') }
+{% endhighlight %}
+
+The @rm_rf@ method deletes the directory and all files in it.  It's named after UNIX's infamous @rm -rf@.  Use it wisely.  This is also a good time to introduce you to @FileUtils@, a standard Ruby library that contains convenient methods for creating and deleting directories, copying and moving files, even comparing two files.  They're all free of charge when you use Buildr.
+
+Now let's "talk about the artifacts":artifacts.html we mentioned before.

data/doc/contributing.textile

@@ -0,0 +1,252 @@
+---
+layout: default
+title: Contributing
+---
+
+Buildr is a community effort, and we welcome all contributors.  Here's your chance to get involved and help your fellow developers.
+
+h2(#involved).  Getting involved
+
+All our discussions are done in the open, over "email":mailing_lists.html, and that would be the first place to look for answers, raise ideas, etc.  For bug reports, issues and patches, "see below":#bugs.
+
+
+h2(#mailing_lists).  Mailing Lists
+
+We run two mailing lists, the "users":http://buildr.markmail.org/search/list:users mailing list for developers working with Buildr, that would be you if you're using Buildr or interested in using it.  There's the "dev":http://buildr.markmail.org/search/list:dev mailing list for talking about development of Buildr itself. There's also "commits":http://buildr.markmail.org/search/list:commits mailing list for following SVN commits and JIRA issues.
+
+Check the "mailing lists":mailing_lists.html page for more information on subscribing, searching and posting to the mailing list.
+
+
+h2(#bugs).  Bugs (aka Issues)
+
+We really do try to keep bugs to a minimum, and anticipate everything you'll ever want to do with Buildr.  We're also, not perfect.  So you may have found a bug, or have an enhancement in mind, or better yet, a patch to contribute. Here's what you can do.
+
+If it's a bug, enhancement or patch, add it to "JIRA":http://issues.apache.org/jira/browse/Buildr.  For trivial stuff, that's good enough.
+
+If it needs more attention, start a discussion over on the mailing list.  We will still use JIRA to log the progress, but the mailing list is a better place for talking things through.
+
+When reporting a bug, please tell us which version of Ruby, Buildr and Java you are using, and also which operating system you are on:
+
+{% highlight sh %}
+$ ruby --version
+$ buildr --version
+$ java --version
+{% endhighlight %}
+
+
+h2(#wiki).  Community Wiki
+
+"Our community Wiki":http://cwiki.apache.org/confluence/display/BUILDR/Index.
+
+
+h2(#code).  Contributing Code
+
+Yes, please.
+
+If you have a patch to submit, do it through "JIRA":http://issues.apache.org/jira/browse/Buildr.  We want to make sure Apache gets the right to use your contribution, and the JIRA upload form includes a simple contribution agreement.  Lawyer not included.
+
+h3.  The Perfect Patch
+
+If you want to get your patch accepted quickly:
+
+#  Provide a good summary of the bug/fix.  We use that to decide which issue we can do quickly, and also copy and paste it into the changelog.
+#  Provide short explanation of what failed, under what conditions, why, and what else could be affected by the change (when relevant).  The helps us understand the problem and move on to the next step.
+#  Provide a patch with relevant specs, or a fix to incomplete/broken specs. First thing we have to do is replicate the problem, before applying the change, and then make sure the change fixes that problem.  And we need to have those specs in there, they make sure we don't accidentally break it again in the future.
+#  Provide a patch with the fix/change itself.  Keep it separate from the specs, so it's easy to apply them individually.
+
+If you don't know how to fix it, but can at least write a spec for the correct behavior (which, obviously would fail), do just that.  A spec is preferred to a fix.
+
+h3.  Working on a new feature?
+
+If you want to work on a cool new feature, but not quite ready to submit a patch, there's still a way you can get the Buildr community involved.  We're experimenting with using Git for that.  You can use Git to maintain a fork of Buildr that can keep up with changes in the main branch (tip: use @git rebase@), while developing your own changes/features on it.
+
+That way you can get other people involved, checking out the code, and eventually merge it back with the main branch.  Check out the "Git section":#git below and the post "Git forking for fun and profit":http://blog.labnotes.org/2008/04/30/git-forking-for-fun-and-profit/.
+
+
+h2(#edge).  Living on the edge
+
+Did we mention Buildr is an open source project?  In fact, when you install Buildr you get all the source code, documentation, test case and everything you need to use it, extend it and patch it.  Have a look in your Gem directory.
+
+h3(#svn).  SVN
+
+But if you want to work with the latest and greatest, you'll want to check out "Buildr from SVN":http://svn.apache.org/repos/asf/buildr:
+
+{% highlight sh %}
+$ svn co http://svn.apache.org/repos/asf/buildr/trunk buildr
+{% endhighlight %}
+
+You can also browse the "Buildr repository":http://svn.apache.org/repos/asf/buildr.
+
+h3(#git).  Git
+
+Not a fan of SVN?  We understand.  You can also use the "official Apache Git clone.":http://git.apache.org  This clone is maintained by the ASF and kept in sync with the SVN repository (though, in practice there may be some delay in cloning recent commits).  Apache's Git hosting supports both git:// and http:// protocols (you should use git:// if at all possible as it is faster than http://):
+
+{% highlight sh %}
+$ git clone git://git.apache.org/buildr.git
+# or...
+$ git clone http://git.apache.org/buildr.git
+{% endhighlight %}
+
+If you want to learn more about Git, you can start by watching Scott Chacon’s "Git presentation":http://en.oreilly.com/rails2008/public/asset/attachment/2816 (PDF), or any of the "Git screencasts":http://www.gitcasts.com/.  For more, there's also the "Git Internals book":http://peepcode.com/products/git-internals-pdf.
+
+And keep this "Git cheat sheet":http://ktown.kde.org/~zrusin/git/git-cheat-sheet-medium.png close at hand. Very useful.
+
+h4. GitHub
+
+You are also welcome to fork or clone the "Buildr repository on GitHub":http://github.com/apache/buildr.  This repository is just an exact mirror of the official Apache Git clone referenced above (updated every 30 minutes).  Some of the core committers also maintain their own forks of Buildr on GitHub, often containing experimental and in-progress development slated for eventual inclusion into the SVN.  For reference, they are listed below:
+
+* "Assaf Arkin":http://github.com/assaf/buildr
+* "Victor Hugo Borja":http://github.com/vic/buildr
+* "Daniel Spiewak":http://github.com/djspiewak/buildr
+
+h3. Working with Source Code
+
+To install Buildr from the source directory:
+
+{% highlight sh %}
+$ cd buildr
+$ rake setup install
+{% endhighlight %}
+
+When using Buildr for JRuby:
+
+{% highlight sh %}
+$ cd buildr
+$ jruby -S rake setup install
+{% endhighlight %}
+
+The _setup_ task takes care of installing all the necessary dependencies used for building, testing and running Buildr. Once in a while we upgrade or add new dependencies, if you're experiencing a missing dependency, simply run @rake setup@ again.
+
+The _install_ task creates a Gem in your working directory (_pkg/_) and install it in your local repository. Since Ruby Gems uses version numbers to detect new releases, if you installed Buildr this way and want to upgrade to the latest official release, you need to use @gem install buildr@ rather than @gem upgrade@.
+
+Both _setup_ and _install_ tasks use the @sudo@ command on platforms that require it (i.e. not Windows), so there's no need to run @sudo rake@ when working with the Buildr source code.
+
+
+h3. Using development build
+
+Occasionally we'll make development builds from the current code in trunk/head. We appreciate if you can take the time to test those out and report any bugs. To install development builds, use the Gem repository at @people.apache.org/~assaf/buildr/snapshot@:
+
+{% highlight sh %}
+gem source --add http://people.apache.org/~assaf/buildr/snapshot/
+{% endhighlight %}
+
+Since Ruby Gems uses version numbers to detect new releases, if you installed Buildr from a snapshot and want to upgrade to a newer snapshot or the latest official release, you need to use @gem install buildr@ rather than @gem upgrade@.
+
+If you want to go back to using the RubyForge releases:
+
+{% highlight sh %}
+gem source --remove http://people.apache.org/~assaf/buildr/snapshot/
+gem install buildr
+{% endhighlight %}
+
+
+h2(#testing).  Tested and Documented
+
+Two things we definitely encourage!
+
+h3.  Testing/Specs
+
+Obviously we won't turn down patches, but we'll love you even more if you include a test case.  One that will fail without the patch, and run successfully with it.  If not for our love, then think of the benefit to you: once we add that test case, we won't accidentally break that feature in the next release.
+
+We test using "RSpec":http://rspec.info/, a Behavior-Driven Development test framework.  The main difference between RSpec and xUnit is that RSpec helps you formulate test cases in terms of specifications: you describe how the code should behave, and run RSpec to make sure it matches that specification.
+
+You can run an individual specifications using the @spec@ command, for example:
+
+{% highlight sh %}
+$ spec spec/compiler_spec.rb
+$ spec spec/compiler_spec.rb -l 409
+{% endhighlight %}
+
+The first command will run all the specifications in @compiler_spec@, the second command will run only the specification identified by line 409 of that file. You can use line numbers to point at a particular specification (lines starting with @it@), or set of specifications (lines starting with @describe@). You can also use the @-e@ command line option to name a particular specification.
+
+To make sure your change did not break anything else, you can run all the specifications (be patient, we have a lot of these):
+
+{% highlight sh %}
+$ rake spec
+{% endhighlight %}
+
+If you get any failures, you can use @rake failed@ to run only the failed specs, and repeat until there are no more failed specs to run. The list of failed specs is stored in the file _failed_.
+
+We always @rake spec@ before making a release.
+
+For full test coverage:
+
+{% highlight sh %}
+$ rake coverage
+{% endhighlight %}
+
+Specification and coverage reports are HTML files you can view with a Web browser, look for them in the _reports_ directory. You can also check out the "RSpec report":specs.html and "test coverage":coverage/index.html we publish with each release.
+
+
+h2(#docs).  Documentation
+
+Yes, we do make typos, spelling errors and sometimes we write things that don't make sense, so if you find a documentation bug, or want to help make the documentation even better, here's the way to do it.
+
+For simple typos and quick fixes, just send a message to the mailing list or log an issue in JIRA.
+
+If you end up rewriting a significant piece of text, or add new documentation (you rock!), send a patch.  Making documentation patches is fairly easy.  All the documentation is generated from text files in the @doc/pages@ directory, so all you need to do is check it out from Git/SVN, edit, and @svn diff@ to create a patch.
+
+We use "Textile":http://www.textism.com/tools/textile/ as the markup language, it takes all of a few minutes to learn, it's intuitive to use, and produces clean HTML.  You can learn it all in a few minutes from the "Textile Reference Manual":http://redcloth.org/textile.  Also check out the "Textile Quick Reference":http://hobix.com/textile/quick.html.
+
+Syntax highlighting handled by "Pygments":http://pygments.org.  Use the special @highlight@ tag to separate code sample from the rest of the text and to tell Pygments which language to use.  For example:
+
+<notextile><pre>
+&#123;&#37; highlight ruby &#37;&#125;
+define 'project' do
+  # Just a sample
+end
+&#123;&#37; endhighlight &#37;&#125;
+</pre></notextile>
+
+Have a look at existing documentation to see writing conventions, specifically:
+
+* Separate paragraphs with two newlines.
+* Use one newline only if you need a &lt;br&gt; tag, otherwise, no newlines inside the paragraph.
+* When creating a new page, don't forget the YAML premable at the top (Jekyll needs the page title and layout).
+* The layout uses H1 to render the page title; only use H2 through H4 for the page content.
+* Use H2 headers for the major page sections.  Give each H2 header a unique ID so the table of contents can link to it.
+* Separating sentences with two spaces, just a convenience when editing in a text editor using monospaced fonts.
+* If in doubt, ask.
+
+To go from Textile to HTML we use "Jekyll":http://github.com/mojombo/jekyll.  You can use the @jekyll@ rake task to transform the files under @doc@ and create a copy of the Web site in the directory @_site@.  For example:
+
+{% highlight sh %}
+$ rake jekyll
+$ open _site/index.html
+{% endhighlight %}
+
+There is no live editing, but you can run @rake jekyll auto=true@, and when you update and save a Textile page it will regenerate the corresponding HTML page.
+
+To go from HTML to PDF we use "PrinceXML":http://www.princexml.com/.  The target file @buildr.pdf@ is generated by first running Jekyll and then merging the generated HTML pages into a single PDF document.  For example:
+
+{% highlight sh %}
+$ rake buildr.pdf
+$ open buildr.pdf
+{% endhighlight %}
+
+
+h2(#contributors).  Contributors
+
+Here is the list of people who are actively working and committing on Buildr:
+
+*"Assaf Arkin":http://labnotes.org* (assaf at apache.org)
+
+Started working on Buildr because Maven was too much pain and Rake wasn't enough.  Assaf has been hanging around Apache since 1999, as founding contributor to XML Apache, Ode and Buildr.  Assaf is also co-author of "Ruby In Practice":http://manning.com/mcanally/.
+
+*Alex Boisvert*
+
+Came to Buildr as a refuge from the Maven Uncertainty Principle.  Alex has been working mostly on the Scala integration and believes Ruby scripting is a great complement to statically typed languages. 
+
+*"Matthieu Riou":http://offthelip.org*
+
+*Victor Hugo Borja* (vborja at apache.org)
+
+Currently a Java Developer at "http://jwmsolutions.com":http://jwmsolutions.com, Victor has been enjoying and using Apache's software since 1999 when he started with Java, now he prefers programming Ruby and is happy to help on Apache's first ruby project. 
+
+*Lacton* (lacton at apache.org)
+
+A test-infected developer since 2001, Lacton yearns for a development infrastructure that would shorten feedback loops so much that testing, building, refactoring and committing would feel as easy and natural as breathing air.
+
+*"Daniel Spiewak":http://www.codecommit.com/blog* (djspiewak at apache.org)
+
+Daniel originally came to Buildr in search of a Scala build tool which was better than Ant.  He got more than he bargained for.  Now, he works to advance Buildr as the absolute best tool for supporting Scala development.