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