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

- old
+ new

@@ -273,16 +273,22 @@ downloaded. tar -Zxvf ruby-X.X.X-*.tar.gz This will create a directory with the same name as the archive, but -without the ''''.tar.gz'''' extension. Now change into this directory -and configure the source code for your specific OS and compile it. -For this to work, you need to have the GNU C compiler and related -utilities installed. We configure Ruby to append ''''19'''' to all -executable names. This way, you can easily choose if you want to run -the old or the new Ruby. ''''ruby'''' runs your distribution Ruby, +without the ''''.tar.gz'''' extension. + +Before you continue, make sure you have all the necessary packages +installed to compile ruby. That would be everything you need to +compile C programs. That includes gcc, make, zlib and libyaml. If +something is missing, you will run into problems in the next 2 steps. +It's sometimes not obvious which package to install to fix the issue. + +Now change into this directory and configure the source code for your +specific OS and compile it. We configure Ruby to append ''''19'''' to +all executable names. This way, you can easily choose if you want to +run the old or the new Ruby. ''''ruby'''' runs your distribution Ruby, ''''ruby19'''' runs your new ruby. cd ruby-X.X.X-* ./configure --program-suffix=19 make @@ -291,31 +297,44 @@ permission, so you need to enter the root password. All executables will be installed into ''''/usr/local/bin''''. sudo make install +The TaskJuggler front-end scripts always use the ''''ruby'''' +interpreter that's the first in the PATH. You need to set a link in +your local ''''bin'''' directory to point to your ''''ruby19'''' +executable as ''''ruby''''. + + ln -s /usr/local/bin/ruby19 ${HOME}/bin/ruby + +Make sure your ''''${HOME}/bin'''' directory is the first directory in +the ''''PATH''''. This step varies a lot depending on the login +shell. E. g. for ''''bash'''' put the following at the end in your +''''.profile'''' shell config file. Please make sure that +''''/usr/local/bin'''' is also in the PATH so that the ruby +executables (all having a ''''19'''' suffix) will be found as well. + + export PATH=${HOME}/bin:${PATH} + +Log out and back in again. Now + + which ruby + +should show return the path to the link to your +''''${HOME}/bin/ruby''''. You now have the latest Ruby installed and +are ready to use TaskJuggler. + As a final step, you need to install the ''''mail'''' and ''''term-ansicolor'''' gems. 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 -The TaskJuggler front-end scripts always use the ''''ruby'''' -interpreter that's the first in the PATH. You need to set a link in -your local ''''bin'''' directory to point to your ''''ruby19'''' -executable as ''''ruby''''. Make sure your ''''${HOME}/bin'''' -directory is the first directory in the ''''PATH''''. - - ln -s /usr/local/bin/ruby19 ${HOME}/bin/ruby - -That's it. You now have the latest Ruby installed and are ready to -use TaskJuggler. - === Installing the Vim Support === TaskJuggler can be used with any text editor that supports UTF-8 text file editing. If you don't have a preference yet, we recommend to try the [http://www.vim.org Vim] text editor. It's a very powerful editor @@ -362,14 +381,14 @@ braces can be collapsed. For this to work, the opening brace needs to be on the same line as the property keyword. The closing brace must be the first non-blank character of the last line of the block. See the '''':help fold'''' Vim help command for details how to open and close folds. -* Tag navigation. If you include a [tagfile] report in your project, +* Tag navigation. If you include a [[tagfile]] report in your project, Vim will know all property IDs and can jump to them. If you have a task with the ID ''''foo.bar'''', the command '''':ta foo.bar'''' will put the cursor right where task ''''foo.bar'''' was declared. -* ID completion. If you include a [tagfile] report in your project, +* ID completion. If you include a [[tagfile]] report in your project, Vim can tell you the full hierarchical ID of a property. Just move the cursor to the first line of the property definition and press ''''Ctrl-]''''. * Run tj3 from within vim. Just type '''':make your_project.tjp'''' to start the scheduling process. In case of errors or warnings, you