manual/Installation in taskjuggler-3.0.0 vs manual/Installation in taskjuggler-3.1.0

- old
+ new

@@ -1,17 +1,12 @@ == Installation == -TaskJuggler III is written in [http://www.ruby-lang.org Ruby]. It +TaskJuggler 3.x is written in [http://www.ruby-lang.org Ruby]. It should run on any platform that Ruby is available on. It uses the standard Ruby mechanism for distribution, a package format called [http://docs.rubygems.org RubyGems]. -TaskJuggler III is still under development. There is no stable -version yet. You are welcome to try it. Some users are already using -it successfully for their purposes, but it might not yet be right for -you. - === Requirements === Ruby applications are platform independent. There is no need to compile anything. But TaskJuggler has a very small set of dependencies that you have to take care of first. Please make sure you @@ -36,11 +31,11 @@ currently unmaintained (and untested) OSes, please contact us via the developer mailing list. ==== Other required Software ==== -* '''Ruby:''' TaskJuggler III is written in Ruby. You need a Ruby +* '''Ruby:''' TaskJuggler 3.x is written in Ruby. You need a Ruby runtime environment to run it. This can be downloaded from [http://www.ruby-lang.org/en/downloads/ here]. Most Linux distributions usually have Ruby already included. So does MacOS X Leopard. For Windows, there is a one-click installer available. The recommended Ruby version to make full use of TaskJuggler is 1.9.2. @@ -52,11 +47,14 @@ See below for instructions on how to use the latest and greates Ruby version in parallel with your distribution Ruby. * '''RubyGems:''' If it did not come with your OS or the Ruby installation, see [http://docs.rubygems.org here] how to get and -install it. +install it. RubyGems is a cross-platform package manager. It will +download and install all other required software packages +automatically when you install TaskJuggler. These packages are called +Ruby gems. Other versions of Ruby (Rubinius, JRuby, etc.) may work but have not been tested. === Installation Steps for Users === @@ -122,11 +120,11 @@ tj3 --version ==== The manual way ==== If the easy way doesn't work for you, you need to download and install -the packages manually. Download TaskJuggler III gem file from the +the packages manually. Download TaskJuggler gem file from the [http://rubygems.org/gems/taskjuggler RubyGems.org] site. A gem package is an operating system and architecture independent archive file for Ruby programs. You can install it on any system that has Ruby and RubyGems installed. Normally, you should be logged-in @@ -148,28 +146,37 @@ PATH=${PATH}:/var/lib/gems/1.8/bin/ Windows and MacOS platforms may require similar steps. -=== Update from older TaskJuggler III versions === +=== Update from older TaskJuggler 3.x versions === Updates work just like the installation. gem update taskjuggler For downloaded or self-built packages use the following command: gem update pkg/taskjuggler-X.X.X.gem -=== Installation Steps for Developers === +=== Installing TaskJuggler from the Git Repository === -The following description is for users that want to learn more about -TaskJuggler or want to make improvements. TaskJuggler is -[http://en.wikipedia.org/wiki/Open_source Open Source] software and +The following description is for developers and users that want to +learn more about TaskJuggler or want to make improvements. TaskJuggler +is [http://en.wikipedia.org/wiki/Open_source Open Source] software and you are encouraged to read and modify the source code. +Before you download the source code, make sure you have all the +necessary dependencies installed. You should have Ruby 1.9.2 or later +and you need to have the following gems installed + + gem install rake mail rspec term-ansicolor rcov + +rcov is optional, but you must have the other gems and their +dependencies installed. + To get the source code, the recommended way it to check out the latest code from the developer repository. To do this, you need to have [http://www.kernel.org/pub/software/scm/git/docs/ git] installed. Then checkout the source code with the following command @@ -202,11 +209,11 @@ another shell. # Make sure the shell finds the TaskJuggler programs export PATH=${PATH}:${TASKJUGGLER_DIR}/bin -=== Quickly switching between various TaskJuggler III versions === +=== Quickly switching between various TaskJuggler 3.x versions === One of the benefits of using TaskJuggler from the Git repository is the ability to get the latest bug fixes. If a bug was reported, it is usually fixed fairly quickly, but it can take several weeks before the next official release happens. The following commands must all be @@ -230,11 +237,11 @@ git tag provides you with a list of all tags. -TaskJuggler III is written in Ruby. There is no make or build process +TaskJuggler 3.x is written in Ruby. There is no make or build process needed. Every code change is effective immediately. The tutorial, the manual and some other parts do require a build step. rake release @@ -284,12 +291,13 @@ permission, so you need to enter the root password. All executables will be installed into ''''/usr/local/bin''''. sudo make install -As a final step, you need to install the ''''mail'''' gem. +As a final step, you need to install the ''''mail'''' and +''''term-ansicolor'''' gems. - sudo gem19 install mail + sudo gem19 install mail term-ansicolor If you don't want to use TaskJuggler from the git repository, you can install the TaskJuggler gem as well. sudo gem19 install taskjuggler