README.md

   1 Eclipse Git Plugin
   2 ==================
   3
   4 EGit is an Eclipse plugin for working with Git repositories. It is based
   5 on the JGit library, which is a Git implementation in pure Java.
   6
   7 This package is licensed under the EPL. Please refer to the LICENSE file
   8 for the complete license.
   9
  10 This package is composed of the following major components:
  11
  12 - org.eclipse.egit.core
  13
  14     An Eclipse plugin providing an interface to org.eclipse.jgit
  15     and support routines to allow processing against the Eclipse
  16     workspace and resource APIs, rather than the standard Java
  17     file APIs. It also supplies the team provider implementation.
  18
  19 - org.eclipse.egit.ui
  20
  21     An Eclipse plugin providing the user interface on top of
  22     org.eclipse.egit.core.
  23
  24 - org.eclipse.egit.core.test
  25
  26     Unit tests for org.eclipse.egit.core.
  27
  28 - org.eclipse.egit.ui.test
  29
  30     UI tests for org.eclipse.egit.ui.
  31
  32 - org.eclipse.egit
  33
  34     A plugin for packaging
  35
  36 - org.eclipse.egit-feature
  37
  38     Also packaging. This project is for building an Eclipse "feature"
  39     out of the plugins above.
  40
  41 - org.eclipse.egit.repository
  42
  43     This package is for producing a p2 repository, i.e. a web site
  44     you can point your eclipse at and just upgrade.
  45
  46 There are other components which provide integration with other plugins.
  47
  48 Warnings/Caveats
  49 ----------------
  50
  51 - Symbolic links are not yet supported because they used to be
  52   unsupported by Java. Such links could be damaged.
  53
  54 - Don't try the plugin with a JDK other than 1.6 (Java 6) unless you
  55   are prepared to investigate problems yourself. JDK 1.5.0_11 and later
  56   Java 5 versions *may* work. Earlier versions do not. JDK 1.4 is *not*
  57   supported. Apple's Java 1.5.0_07 is reported to work acceptably. We
  58   have no information about other vendors. Please report your findings
  59   if you try.
  60
  61 - CRLF conversion works for some things, but is in general still being
  62   worked on.
  63
  64 Compatibility
  65 -------------
  66
  67 - Eclipse 3.5.2 is the minimum Eclipse version for EGit 0.9 and later.
  68
  69 - Newer version of EGit may implement new functionality, remove
  70   existing functions and change others without other notice than what
  71   is written in the commit log and source files themselves.
  72
  73
  74 Package Features
  75 ----------------
  76
  77 The following list is not complete, but it gives an overview of the
  78 features:
  79
  80 - org.eclipse.egit.core
  81
  82     * Supplies an Eclipse team provider.
  83
  84     * Connect/disconnect the provider to a project.
  85
  86     * Search for the repositories associated with a project by
  87       autodetecting the Git repository directories.
  88
  89     * Store which repositories are tied to which containers in the
  90       Eclipse workspace.
  91
  92     * Tracks moves/renames/deletes and reflects them in the cache
  93       tree.
  94
  95     * Resolves through linked containers.
  96
  97 - org.eclipse.egit.ui
  98
  99     * Connect team provider wizard panels.
 100
 101     * Connect to Git team provider by making a new repository.
 102
 103     * Connect to Git team provider by searching local filesystem
 104       for existing repository directories.
 105
 106     * Team actions: track (add), untrack (remove), disconnect, show
 107       history, compare version.
 108
 109     * Resource decorator shows file/directory state in the package
 110       explorer and other views.
 111
 112     * Creating new commits or amending commits.
 113
 114     * View for staging changes (whole files and partial staging),
 115       showing their differences and committing them.
 116
 117     * Graphical history viewer with the ability to compare versions
 118       using eclipse built-in compare editor.
 119
 120     * Clone, push, pull, fetch
 121
 122     * Merge, rebase, cherry-pick
 123
 124
 125 Missing Features
 126 ----------------
 127
 128 - gitattributes support
 129
 130   In particular CRLF conversion is not yet fully implemented.
 131
 132
 133 Support
 134 -------
 135
 136 Post question or comments to the egit-dev@eclipse.org mailing list.
 137 You need to be subscribed to post, see here:
 138
 139 https://dev.eclipse.org/mailman/listinfo/egit-dev
 140
 141
 142 Contributing
 143 ------------
 144
 145 See the EGit Contributor Guide:
 146
 147 http://wiki.eclipse.org/EGit/Contributor_Guide
 148
 149
 150 About Git
 151 ---------
 152
 153 More information about Git, its repository format, and the canonical
 154 C based implementation can be obtained from the Git websites:
 155
 156 http://git-scm.com/