README.textile

   1 h1. EMF Compare
   2
   3 h2. Installation
   4
   5 * The latest version of EMF Compare can be installed from http://download.eclipse.org/modeling/emf/compare/updates/releases/2.1
   6 * More detailed installation instructions on http://www.eclipse.org/emf/compare/documentation/latest/user/user-guide.html#Installing_EMF_Compare
   7
   8 h3. Prerequesites
   9
  10 EMF Compare can be installed on the following Eclipse platforms :
  11
  12 * Eclipse version 3.5 (Galileo) to Eclipse version 4.4 (Luna)
  13 * Java 1.5 to Java 1.7
  14
  15 h3. Compatibility
  16
  17 Take note that parts of the EMF Compare optional supports can only be installed on later Eclipse versions. Namely :
  18
  19 |_. Feature                          |_. Eclipse 4.4 (Luna) |_. Eclipse 4.3 (Kepler) |_. Eclipse 4.2 (Juno) |_. Eclipse 3.7 (Indigo) |_. Eclipse 3.6 (Helios) |_. Eclipse 3.5 (Galileo) |
  20 | EMF Compare Core                   | X                    | X                      | X                    | X                      | X                      | X                       |
  21 | EMF Compare RCP UI                 | X                    | X                      | X                    | X                      | X                      | X                       |
  22 | EMF Compare IDE UI                 | X                    | X                      | X                    | X                      | X                      | X                       |
  23 | EMF Compare UML integration        | X                    | X                      | X                    |                        |                        |                         |
  24 | EMF Compare GMF integration        | X                    | X                      | X                    |                        |                        |                         |
  25 | EMF Compare EcoreTools integration | X                    | X                      | X                    |                        |                        |                         |
  26 | EMF Compare Papyrus integration    | X                    | X                      | X                    |                        |                        |                         |
  27
  28 h2. Reporting Bugs
  29
  30 There may be errors in the <workspace>/.metadata/.log or even on stdout that can help you track down and problem.
  31 When reporting errors, please include stack traces when applicable and the commit id or the version your plugin is built from, or the version of the plugin if it does not contain a date.
  32
  33 * Bugs or enhancement requests should be reported on the Eclipse bugzilla at https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EMFCompare&component=
  34 * Check http://www.eclipse.org/emf/compare/support/ for more details on support issues
  35
  36 h2. Build
  37
  38 EMF Compare can be built using maven from within the org.eclipse.emf.compare-parent sub-folder of this repository :
  39
  40 @mvn clean package -Pluna@
  41
  42 The above example will build the EMF Compare binaries against a Luna platform. Select the appropriate profile according to the platform you wish to install EMF Compare on, one in [luna, kepler, juno, indigo, helios, galileo].
  43
  44 You can also check the tests using
  45
  46 @mvn verify -Pluna --fail-at-end -Dmaven.test.failure.ignore=true@
  47
  48 h2. Contributing
  49
  50 * You need an Eclipse user account. You already have one if you are an Eclipse commiter or have a "Bugzilla":http://bugs.eclipse.org/bugs account. Otherwise, use "this form":https://dev.eclipse.org/site_login/createaccount.php.
  51 * Sign the Eclipse Contributing License Agreement (CLA) : Please go to "your user page":https://projects.eclipse.org/user/login/sso , then to the CLA tab once you're logged in and follow the instructions.
  52 * Make sure you use the proper user information on your git clone's configuration :
  53 ** @$ cd <path/to/repository>@
  54 ** @$ git config --local user.name "<Full Name>"@
  55 ** @$ git config --local user.email "<your.mail@yourmail.com>"@
  56
  57 * Make small logical changes.
  58 * Provide a meaningful commit message.
  59
  60 EMF Compare uses gerrit for peer reviews.
  61 To configure it on your repository, please look up how to setup your SSH keys and remote on the "wiki":https://wiki.eclipse.org/EMF_Compare/Gerrit#SSH .
  62 A detailed guide on the commit message's format can be found further down this same page.
  63
  64 Once properly configured, you will be able to request a review by simply pushing your commit on this new remote.
  65
  66 A comprehensive contributor guide can also be found on "the project's wiki":https://wiki.eclipse.org/EMF_Compare/Contributor_Guide
  67