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 supported on Java 7 and higher and require that the
  52   optional JGit Java 7 feature is installed. For remaining issues
  53   with symbolic link support see
  54   https://bugs.eclipse.org/bugs/show_bug.cgi?id=429304.
  55
  56 - CRLF conversion works for some things, but is in general still being
  57   worked on.
  58
  59 Compatibility
  60 -------------
  61
  62 - In general, EGit supports at least the latest two Eclipse releases.
  63   For details, please see https://wiki.eclipse.org/EGit/FAQ
  64
  65 - Newer version of EGit may implement new functionality, remove
  66   existing functions and change others without other notice than what
  67   is written in the commit log and source files themselves.
  68
  69
  70 Package Features
  71 ----------------
  72
  73 The following list is not complete, but it gives an overview of the
  74 features:
  75
  76 - org.eclipse.egit.core
  77
  78     * Supplies an Eclipse team provider.
  79
  80     * Connect/disconnect the provider to a project.
  81
  82     * Search for the repositories associated with a project by
  83       autodetecting the Git repository directories.
  84
  85     * Store which repositories are tied to which containers in the
  86       Eclipse workspace.
  87
  88     * Tracks moves/renames/deletes and reflects them in the cache
  89       tree.
  90
  91     * Resolves through linked containers.
  92
  93 - org.eclipse.egit.ui
  94
  95     * Connect team provider wizard panels.
  96
  97     * Connect to Git team provider by making a new repository.
  98
  99     * Connect to Git team provider by searching local filesystem
 100       for existing repository directories.
 101
 102     * Team actions: track (add), untrack (remove), disconnect, show
 103       history, compare version.
 104
 105     * Resource decorator shows file/directory state in the package
 106       explorer and other views.
 107
 108     * Creating new commits or amending commits.
 109
 110     * View for staging changes (whole files and partial staging),
 111       showing their differences and committing them.
 112
 113     * Graphical history viewer with the ability to compare versions
 114       using eclipse built-in compare editor.
 115
 116     * Clone, push, pull, fetch
 117
 118     * Merge, rebase, cherry-pick
 119
 120
 121 Missing Features
 122 ----------------
 123
 124 - gitattributes support
 125
 126   In particular CRLF conversion is not yet fully implemented.
 127
 128
 129 Support
 130 -------
 131
 132 Post question or comments to the egit-dev@eclipse.org mailing list.
 133 You need to be subscribed to post, see here:
 134
 135 https://dev.eclipse.org/mailman/listinfo/egit-dev
 136
 137
 138 Contributing
 139 ------------
 140
 141 See the EGit Contributor Guide:
 142
 143 http://wiki.eclipse.org/EGit/Contributor_Guide
 144
 145
 146 About Git
 147 ---------
 148
 149 More information about Git, its repository format, and the canonical
 150 C based implementation can be obtained from the Git websites:
 151
 152 http://git-scm.com/