README.rdoc

   1 = Buildr
   2
   3 This is Buildr, the build system that doesn't suck.
   4
   5 http://incubator.apache.org/buildr/
   6
   7
   8 == Get Started
   9
  10 === Install Buildr
  11
  12 Buildr needs Ruby 1.8 or later and RubyGems 0.9 or later.
  13
  14 Windows users can get the one-click Ruby installer, which includes the latest
  15 version of Ruby and RubyGems:
  16
  17 http://rubyinstaller.rubyforge.org
  18
  19 Make sure to set JAVA_HOME environment variable first, then:
  20
  21   gem install buildr
  22
  23 (Use sudo for Linux and OS X)
  24
  25 More installation and setup instructions available online
  26 http://incubator.apache.org/buildr/
  27
  28
  29 === RTFM
  30
  31 * Buildr documentation: http://incubator.apache.org/buildr/
  32 * More about Rake: http://docs.rubyrake.org
  33 * Antwrap documentation: http://antwrap.rubyforge.org
  34
  35
  36 === Mailing list
  37
  38 Users: http://mail-archives.apache.org/mod_mbox/incubator-buildr-user/
  39
  40 Developers: http://mail-archives.apache.org/mod_mbox/incubator-buildr-dev/
  41
  42 Create your own Buildfile and start living the life!
  43
  44
  45 == Where's My Ruby?
  46
  47 Buildr needs Ruby 1.8 or later and RubyGems 0.9 or later. All other
  48 dependencies are installed when you run:
  49
  50   gem install buildr
  51
  52 === Windows
  53
  54 Windows users can get the one-click Ruby installer, which includes the latest
  55 version of Ruby and RubyGems:
  56
  57 http://rubyinstaller.rubyforge.org
  58
  59 Before installing Buildr, please set the JAVA_HOME environment variable to
  60 point to your JDK distribution.  Next, use Ruby Gem to install Buildr:
  61
  62   > gem install buildr
  63
  64 When prompted for a platform, select mswin32.
  65
  66 === Linux, BSD, Cygwin
  67
  68 On Linux/BSD/Cygwin, use your default package manager, for example, for Ubuntu:
  69
  70 $ sudo apt-get install ruby
  71 $ sudo apt-get install ruby1.8-dev
  72 $ sudo apt-get install build-essential
  73 $ sudo apt-get install libopenssl-ruby
  74
  75 Before installing Buildr, please set the JAVA_HOME environment variable to
  76 point to your JDK distribution.  Next, use Ruby Gem to install Buildr:
  77
  78   $ sudo env JAVA_HOME=$JAVA_HOME gem install buildr
  79
  80 When prompted for a platform, select ruby.
  81
  82 === OS X
  83
  84 Leopard includes the latest version of Ruby, if you are using Tiger or an older
  85 release, we recommend re-installing the latest:
  86
  87 http://hivelogic.com/narrative/articles/ruby-rails-mongrel-mysql-osx
  88
  89 To install Buildr:
  90
  91   $ sudo gem install buildr
  92
  93 When prompted for a platform, select ruby.
  94
  95
  96 == Living On the Edge
  97
  98 You can check the latest sources from SVN:
  99
 100   svn co http://svn.apache.org/repos/asf/incubator/buildr/trunk
 101
 102 Or browse the SVN repository online:
 103 http://svn.apache.org/repos/asf/incubator/buildr
 104
 105 If you prefer Git, a Git fork is available from http://github.com/vic/buildr/tree/master:
 106
 107   git clone git://github.com/vic/buildr.git
 108
 109 To install Buildr locally from source:
 110
 111   cd buildr
 112   rake install
 113
 114 If the cutting edge doesn't work, make sure to check the CHANGELOG, to see
 115 which changes might have broken your build.  To run all the test cases:
 116
 117   rake spec
 118
 119
 120 == License
 121
 122 Licensed to the Apache Software Foundation (ASF) under one or more
 123 contributor license agreements.  See the NOTICE file distributed with this
 124 work for additional information regarding copyright ownership.  The ASF
 125 licenses this file to you under the Apache License, Version 2.0 (the
 126 "License"); you may not use this file except in compliance with the License.
 127 You may obtain a copy of the License at
 128
 129   http://www.apache.org/licenses/LICENSE-2.0
 130
 131 Unless required by applicable law or agreed to in writing, software
 132 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 133 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 134 License for the specific language governing permissions and limitations under
 135 the License.
 136
 137
 138 == Disclaimer
 139
 140 Apache Buildr is an effort undergoing incubation at The Apache Software
 141 Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of
 142 all newly accepted projects until a further review indicates that the
 143 infrastructure, communications, and decision making process have stabilized in
 144 a manner consistent with other successful ASF projects. While incubation status
 145 is not necessarily a reflection of the completeness or stability of the code,
 146 it does indicate that the project has yet to be fully endorsed by the ASF.