README

Path: README
Last Update: Thu Nov 20 05:11:02 +0100 2008

About TaskJuggler III

TaskJuggler III is an Open Source project management software. Right now it is just a prototype of what will become the next generation of TaskJuggler. If you are looking for a stable software to manage your projects, use the 2.x series releases.

In contrast to the 2.x version TaskJuggler III should be easily installable and usable on non Unix/Linux systems as well. If you don‘t fear the command prompt and can handle a text editor you can even use it on Windows and MacOS X.

Copyright and License

TaskJuggler is (c) 2006, 2007, 2008 by Chris Schlaeger <cs (at) kde (dot) org>

This program is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. You accept the terms of this license by distributing or using this software.

TaskJuggler is a trademark of Chris Schlaeger.

Installation

TaskJuggler III is written in Ruby. It should run on any platform that Ruby is available on. It uses the standard Ruby mechanism for distribution. The package format is called Ruby Gems. Alternatively, you can install from a the source code using setup.rb.

This is a prototype. Consider it being alpha quality at best!

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 have the minimum required version installed.

Ruby
TaskJuggler III is written in Ruby. You need a Ruby runtime environment to run it. This can be downloaded from here. Most Linux distributions usually have Ruby already included. So does MacOS X Leopard. For Windows, there is a one-click installer available. TaskJuggler currently needs at least Ruby version 1.8.5.
RubyGems
If it did not come with your OS or Ruby package, see here how to get and install it.
Rake
Rake is only needed when you start with the source code from the Git repository. It‘s not needed when you already have a Gem package.
TaskJuggler
Get TaskJuggler III from the Download Page

Installation Process

If you have checked-out the git repository, you need to build the Gem package first.

cd taskjuggler3; ./makedist

To install the Gem package, just run as root the following command.

gem install pkg/taskjuggler3-0.0.1.gem

It will install all components of the Gem in the appropriate place.

Update from previous versions

Updates work just like the installation.

gem update pkg/taskjuggler3-0.0.1.gem

Using TaskJuggler III

The user manual can be found in folder data/manual of the Gem file or at the TaskJuggler Web Site.

Understanding the source code

Ruby code is usually pretty readable even if you don‘t know Ruby yet. Additionally, we have tried to document all critical parts of the code well enough for other people to understand the code. When browsing the code you should start with the file taskjuggler3.rb and the class TaskJuggler.

[Validate]