Enable creating a new git repository in a non-empty folder
[egit/eclipse.git] / EGIT_INSTALL
blob2697a8a926c1cf0fcf5485885a6a397fee017fd1
2         EGit Installation
4 PREREQUISITES
6 In order to install the Git Eclipse plugin you need to have the following
7 things.
9 - Eclipse version 3.5 (Ganymede) or 3.6 (Helios)
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-mapped 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 :).
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 performed using both Cygwin and MSYS git.
20   Both have issues that we need both feedback and patches for.
22 AUTOMATED INSTALLATION INSTRUCTIONS
24 - Find installation instructions on http://www.eclipse.org/egit/download/
26 MANUAL INSTALLATION INSTRUCTIONS
28 - Delete any old versions of the plugin in the <eclipse-path>/plugins/org.eclipse.egit.*
29 - Start eclipse
30 - Make sure a recent JDK 1.5.0_11 or JDK 1.6.x is among your installed JRE's. Which
31   one is the default should not matter but Java 6 is recommended. 
32 - Import the egit projects. Make sure there are no compilation errors
33 - Now you can either export the plugin to a set of jar files to use in an Eclipse 
34   installation or run it from within Eclipse. The latter is for development and 
35   tracking down bugs.
36 - Export the plugin by selecting the org.eclipse.egit.* packages in package
37   explorer and choosing File/Export. Then select Deployable plug-ins and 
38   fragments and choose the Next button. Set Directory to the top of your
39   installation directory (NOT the plugins directory). Select Finish. After 
40   that restart Eclipse. You can associate a project with Eclipse using the
41   Team>Share menu in the context menu when a project is selected.
43 DEBUGGING INSTRUCTIONS
45 - Select the org.eclipse.egit.ui project, and using the context menu select
46   Run As(or Debug As) / Eclipse Application. Make sure the application runs
47   using JDK 1.6 (or JDK1.5.0_11 or newer) if you have any problems.
49 REPORTING BUGS
51 - There may be errors in the <workspace>/.metadata/.log or even on stdout that can help
52   you track down and problem. When reporting errors include stack traces and the commit
53   id or the version your plugin is built from, or the version of the plugin if it does
54   not contain a date.
56 - Check http://www.eclipse.org/egit/support/ to find information about reporting bugs.