ianheggie/cruisecontrol.rb

View on GitHub
app/views/documentation/docs.html.red

Summary

Maintainability
Test Coverage
h1. What is CruiseControl.rb?

CruiseControl.rb is a continuous integration tool. Its basic purpose in life is to alert members of a software project
when one of them checks something into source control that breaks the build.

CC.rb is easy to install, pleasant to use and simple to hack. It's written in "Ruby":http://www.ruby-lang.org/en/.

p(hint). Hint: "Martin Fowler":http://martinfowler.com/ explains the how and why of Continuous Integration in this
         "article":http://martinfowler.com/articles/continuousIntegration.html.

h1. Feature list

* Can be installed in 10 minutes. "More...":/documentation/getting_started#install-prerequisites

* Works out of the box with a regular "Ruby":http://www.ruby-lang.org/en/ or "Ruby on Rails":http://rubyonrails.org
  project. No configuration necessary. "More...":/documentation/manual

* Works with Java Ant, .NET NAnt and any build tool that can be invoked through command line and returns a non-zero exit code if
  the build fails. "More...":/documentation/manual#changing_the_build_command

* Web-based dashboard, convenient, useful and pretty. "More...":/

* When a build is broken or fixed, notifies users via email, instant messaging, "CCMenu":http://ccmenu.sf.net or "CCTray":http://ccnet.sourceforge.net/CCNET/CCTray.html. "More...":/documentation/getting_notified

* RSS feed to track the build status of your favourite projects. "More...":/documentation/getting_notified#other

* Jump to the code causing a build error in one click.

* Displays custom build artifacts. No configuration necessary. "More...":/documentation/manual#handling_custom_build_artifacts

* Extendable through builder plugins, custom build schedulers and other configuration options.

* Infinitely hackable thanks to publicly available source code and Ruby open classes.

* Free as in "free beer".

h1. Demo site

<strong>"Here":http://cruisecontrolrb.thoughtworks.com/projects</strong> is a public CruiseControl.rb instance
building itself and some other open-source projects. 

<div class="next_step">
  Next step: <%= link_to_download 'Download' %> CruiseControl.rb and
  "get started":/documentation/getting_started
</div>