Fork EGit into its own project
[egit.git] / README
blob26fc8650c731407deac2ced6537ed5c7eb2e579a
1             == Eclipse GIT plugin ==
3 This package is licensed under the EPL.  Please refer to the COPYING
4 and LICENSE files for the complete licenses within each package.
6 This package is actually composed of three major components plus
7 three for packaging.
9   org.spearce.egit.core/
11     An Eclipse plugin providing an interface to org.spearce.jgit
12     and support routines to allow processing against the Eclipse
13     workspace and resource APIs, rather than the standard Java
14     file APIs.  It also supplies the team provider implementation.
15     Everything here is EPL.
17   org.spearce.egit.ui/
19     An Eclipse plugin providing the user interface on top of
20     org.spearce.egit.core.
22     Everything here is EPL.
24   org.spearce.egit.core.test/
26     Unit tests for org.spearce.egit.core.
28     Everything here is EPL.
30   org.spearce.egit/
32     A plugin for packaging
34     Everything here is EPL.
36   org.spearce.egit-feature
38     Also packaging. This project is for building an Eclipse "feature"
39     out of the plugins above.
41     Everything here is EPL.
43   org.spearce.egit-updatesite/
45     This package is for producing and update site, i.e. a web site
46     you can point your eclipse at and just upgrade.
48     Everything here is EPL.
50             == WARNINGS / CAVEATS              ==
52 - Symbolic links are not supported because java does not support it.
53   Such links could be damaged.
55 - Only the timestamp of the index is used by jgit check if  the index
56   is dirty.
58 - Don't try the plugin with a JDK other than 1.6 (Java 6) unless you
59   are prepared to investigate problems yourself. JDK 1.5.0_11 and later
60   Java 5 versions *may* work. Earlier versions do not. JDK 1.4 is *not*
61   supported. Apple's Java 1.5.0_07 is reported to work acceptably. We
62   have no information about other vendors. Please report your findings
63   if you try.
65 - CRLF conversion is never performed. On Windows you should thereforc
66   make sure your projects and workspaces are configured to save files
67   with Unix (LF) line endings.
69             == COMPATIBILITY                   ==
71 - Eclipse 3.4 is the minimum Eclipse version.
73 - Newer version of EGit may implement new functionality, remove
74   existing functions and change others without other notice than what
75   is written in the commit log and source files themselves.
78             == Package Features                ==
80   org.spearce.egit.core/
82     * Supplies an Eclipse team provider.
84     * Connect/disconnect the provider to a project.
86     * Search for the repositories associated with a project by
87       autodetecting the GIT repository directories.
89     * Store which repositories are tied to which containers in the
90       Eclipse workspace.
92     * Tracks moves/renames/deletes and reflects them in the cache
93       tree.
95     * Resolves through linked containers.
97   org.spearce.egit.ui/
99     * Connect team provider wizard panels.
101     * Connect to GIT team provider by making a new repository.
103     * Connect to GIT team provider by searching local filesystem
104       for existing repository directories.
106     * Team actions: track (add), untrack (remove), disconnect, show
107       history, compare version.
109     * Resource decorator shows file/directory state in the package
110       explorer and other views.
112     * Creating new commits or amending commits.
114     * Graphical history viewer with the ability to compare versions
115       using eclipse built-in compare editor.
117      * Clone, push, fetch
119             == Missing Features                ==
121 There are a lot of missing features. You need the real Git for this.
122 For some operations it may just be the preferred solution also. There
123 are not just a command line, there is e.g. git-gui that makes committing
124 partial files simple.
126 - Merging. 
128 - Repacking from within the plugin.
130 - Generate a GIT format patch.
132 - Apply a GIT format patch.
134 - Documentation. :-)
136 - gitattributes support
137   In particular CRLF conversion is not implemented. Files are treated
138   as byte sequences.
140 - submodule support
141   Submodules are not supported or even recognized.
143 - The Eclipse plugin cannot handle files outside any Eclipse project. You
144   need commit changes to such files outside of Eclipse.
146             == Support                         ==
148   Post question, comments or patches to the git@vger.kernel.org mailing list.
151             == Contributing                    ==
153   See SUBMITTING_PATCHES in this directory. However, feedback and bug reports
154   are also contributions.
157             == About GIT                       ==
159 More information about GIT, its repository format, and the canonical
160 C based implementation can be obtained from the GIT websites:
162   http://git.or.cz/
163   http://www.kernel.org/pub/software/scm/git/
164   http://www.kernel.org/pub/software/scm/git/docs/