INSTALL

   1
   2         EGit/JGit installation
   3
   4 PREREQUISITES
   5
   6 In order to install the Git Eclipse plugin you need to have the following
   7 things.
   8
   9 - Eclipse version 3.2.1 or later (works up to 3.4 M1).
  10
  11 - Java 6. Java 1.5.0_11 and later seems to work. The reason is that
  12   the garbage collection does not do a good enough job when using memory
  13   mapped files. The sources can be hacked to used non-mmaped files but
  14   that is very slow. JDK 1.4.x is *not* supported at all and JDK 1.5 is only
  15   supported as long as it works :).
  16
  17 - A reasonably recent version of Git itself installed on your platform to
  18   take care of what the plugin does not yet do or do things that native
  19   git does better. Some tests have been peformed using both Cygwin and MSYS git.
  20   Both have issues that we need both feedback and patches for.
  21
  22 INSTALLATION INSTRUCTIONS
  23
  24 - Delete any old versions of the plugin in the <eclipse-path>/plugins/org.spearce.*
  25 - Start eclipse
  26 - Make sure a recent JDK 1.5.0_11 or JDK 1.6.x is among your installed JRE's. Which
  27   one is the default should not matter but Java 6 is recommended.
  28 - Import the egit projects. Make sure there aare no compilation errors
  29 - Now you can either export the plugin to a set of jar files to use in an Eclipse
  30   installation or run it from within Eclipse. The latter is for development and
  31   tracking down bugs.
  32 - Export the plugin by selecting the org.spearce.* packages in package
  33   explorer and choosing File/Export. Then select Deployable plug-ins and
  34   fragments and choose the Next button. Set Directory to the top of your
  35   installation directory (NOT the plugins directory). Select Finish. After
  36   that restart Eclipse. You can associate a project withe Eclipse using the
  37   Team>Share meny in the context meny when a project is selected.
  38
  39 DEBUGGING INSTRUCTIONS
  40 - Select the org.spearce.egit.ui project, and using the context menu select
  41   Run As(or Debug As) / Eclipse Application. Make sure the application runs
  42   using JDK 1.6 (or JDK1.5.0_11 or newer) if you have any problems.
  43
  44 There may be errors in the <workspace>/.metadata/.log or even on stdout that can help
  45 you track down and problem. When reporting errors include stack traces and the commit
  46 id or the version your plugin is built from, or the version of the plugin if it does
  47 not contain a date.