Author: assaf
Date: Mon Jun 30 17:59:29 2008
New Revision: 672968
URL: http://svn.apache.org/viewvc?rev=672968&view=rev
Log:
BUILDR-81: Proper disclaimer regarding RubyForge/Github distributions.
Modified:
incubator/buildr/trunk/doc/pages/contributing.textile
incubator/buildr/trunk/doc/pages/download.textile
incubator/buildr/trunk/doc/pages/getting_started.textile
Modified: incubator/buildr/trunk/doc/pages/contributing.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/contributing.textile?rev=672968&r1=672967&r2=672968&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/contributing.textile (original)
+++ incubator/buildr/trunk/doc/pages/contributing.textile Mon Jun 30 17:59:29
2008
@@ -55,6 +55,8 @@
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.
+h4. Using 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/incubator/buildr:
@@ -65,13 +67,31 @@
You can also browse the "Buildr
repository":http://svn.apache.org/repos/asf/incubator/buildr.
+h4. Using Git
+
Not a fan SVN? We understand. You can also grab a copy of "Buildr from
-Github":http://github.com/vic/buildr/tree/master:
+GitHub":http://github.com/vic/buildr/tree/master:
{{{!sh
$ git clone git://github.com/vic/buildr.git
}}}
+The GitHub repository is maintained by contributors to this project, but is
+*not* an official Apache repository. To obtain Buildr from the official Apache
+repository, consider using @giv-svn@ instead.
+
+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 handy at
+hand. Very useful.
+
+h4. Installing from Source
+
To install Buildr from the source directory:
{{{!sh
Modified: incubator/buildr/trunk/doc/pages/download.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/download.textile?rev=672968&r1=672967&r2=672968&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/download.textile (original)
+++ incubator/buildr/trunk/doc/pages/download.textile Mon Jun 30 17:59:29 2008
@@ -4,15 +4,28 @@
h2. Installing Buildr
The easiest way to install Buildr is using the fabulous RubyGems package
-manager. Of course, you will need either Ruby or JRuby, and we recommend a
-recent version of RubyGems and if this sounds foreign to you, don't worry.
-We'll show you how to install Buildr on Linux, OS/X, Windows and JRuby in the
-"Getting Started guide":getting_started.html, we even provide automated
-installation scripts.
+manager. Of course, you will need either Ruby or JRuby, and we recommend
+upgrading to the most recent version of RubyGems. If this sounds foreign to
+you, don't worry. We'll show you how to install Buildr on Linux, OS/X, Windows
+and JRuby in the "Getting Started guide":getting_started.html, we even provide
+automated installation scripts.
+
+The *official Apache distribution* consists of the digitally signed binaries
+(gems) and source packages "available below":#binaries_and_source_code. To
+install these binaries, you must first download them to disk and then install
+them using the @gem install@ command (or @rake install@ for a source
+distribution).
+
+In addition, contributors to this project maintain a separate distribution over
+on "RubyForge":http://rubyforge.org/projects/buildr. Using this distribution,
+you're able to install Buildr directly from the remote gem repository and to
+automatically upgrade when a new release comes out. The RubyForge distribution
+is *not* an official Apache distribution.
h2. Binaries and Source Code
+
h3. buildr 1.3.1-incubating (2008-05-19)
|_. Package |_. MD5 Checksum |_. PGP |
Modified: incubator/buildr/trunk/doc/pages/getting_started.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/getting_started.textile?rev=672968&r1=672967&r2=672968&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/getting_started.textile (original)
+++ incubator/buildr/trunk/doc/pages/getting_started.textile Mon Jun 30
17:59:29 2008
@@ -3,12 +3,16 @@
h2. Installing Buildr
The installation instructions are slightly different for each operating system.
-If you are using Ruby, pick the one that best matches your operating system and
-target platform.
+Pick the one that best matches your operating system and target platform.
-p(note). The current release of Buildr for Ruby does not work with Java 6 and
-can only be used with Java 1.5 or earlier. "Buildr for JRuby":#jruby works
-nicely with Java 6, consider using that instead.
+The @gem install@ and @gem update@ commands install Buildr from a binary
+distribution provided through "RubyForge":http://rubyforge.org/projects/buildr.
+This distribution is maintained by contributors to this project, but is *not*
+an official Apache distribution. You can obtain the official Apache
+distribution files from the "download page":download.html.
+
+The current release of Buildr for Ruby may not work well with Java 6, only
+Java 1.5 or earlier. If you need to use Java 6, consider "Buildr for
JRuby":#jruby.
h3. Linux
