Permalink
Browse files

Edited README for clarity and formatting.

  • Loading branch information...
1 parent 2d6b6e6 commit 2acf3e3ee2cc7fcedbb2a0aeb228c7c216c985dc @bguthrie bguthrie committed Aug 15, 2011
Showing with 11 additions and 7 deletions.
  1. +11 −7 README.rdoc
View
@@ -1,25 +1,29 @@
-== {CruiseControl.rb}[http://cruisecontrolrb.thoughtworks.com]
+= CruiseControl.rb: Simple Continuous Integration
-=== What's this?
+=== Introduction
-{CruiseControl.rb}[http://cruisecontrolrb.thoughtworks.com] is a continuous integration tool. Its basic purpose in life is to alert members of a software project when one of them checks into a source control system something that breaks the build.
+{CruiseControl.rb}[http://cruisecontrolrb.thoughtworks.com] is a {continuous integration}[http://martinfowler.com/articles/continuousIntegration.html] server. It keeps everyone in your team informed about the health and progress of your project.
-CC.rb is easy to install, pleasant to use and simple to hack. It's written in Ruby.
+CC.rb is easy to install, pleasant to use and simple to hack. It's written in Ruby and maintained in their spare time by developers at {ThoughtWorks}[http://www.thoughtworks.com], a software development consultancy.
+
+=== Links
-=== Stuff
* Documentation: http://cruisecontrolrb.thoughtworks.com/documentation
* Download: https://github.com/thoughtworks/cruisecontrol.rb (click the Downloads button)
* Source: http://github.com/thoughtworks/cruisecontrol.rb
* Issue Tracking: https://github.com/thoughtworks/cruisecontrol.rb/downloads
* Mailing Lists: http://rubyforge.org/mail/?group_id=2918
=== The quick how-to
- $ ./cruise add [project-name] -r [repository] -s [svn|git|hg|bzr]
+
$ ./cruise start
-This should start cruise on port 3333.
+This should start CC.rb on port 3333. To add new projects, there's a GUI interface, or you can use the command line:
+
+ $ ./cruise add [project-name] -r [repository] -s [svn|git|hg|bzr]
=== License:
+
* Apache Software License 2.0
(C) ThoughtWorks Inc. 2007 - 2011

0 comments on commit 2acf3e3

Please sign in to comment.