-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: lgoubet <laurent.goubet@obeo.fr>
- Loading branch information
Showing
1 changed file
with
18 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,48 @@ | ||
| h1. EMF Compare | ||
|
|
||
| Eclipse EMF Compare brings model comparison to the EMF framework. | ||
| It provides generic support for any kind of metamodel in order to compare and merge models. | ||
| The objectives of this component are to provide a stable and efficient generic implementation of model comparison as well as an extensible framework for specific needs. | ||
|
|
||
| h2. Installation | ||
|
|
||
| * The latest version of EMF Compare can be installed from http://download.eclipse.org/modeling/emf/compare/updates/releases/3.0 | ||
| * The latest version of EMF Compare can be installed from https://download.eclipse.org/modeling/emf/compare/updates/releases/latest/ | ||
| * More detailed installation instructions on http://www.eclipse.org/emf/compare/documentation/latest/user/user-guide.html#Installing_EMF_Compare | ||
|
|
||
| h3. Prerequesites | ||
|
|
||
| EMF Compare can be installed on the following Eclipse platforms : | ||
|
|
||
| * Eclipse version 3.5 (Galileo) to Eclipse version 4.4 (Luna) | ||
| * Java 1.5 to Java 1.7 | ||
|
|
||
| h3. Compatibility | ||
|
|
||
| Take note that parts of the EMF Compare optional supports can only be installed on later Eclipse versions. Namely : | ||
|
|
||
| |_. 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) | | ||
| | EMF Compare Core | X | X | X | X | X | X | | ||
| | EMF Compare RCP UI | X | X | X | X | X | X | | ||
| | EMF Compare IDE UI | X | X | X | X | X | X | | ||
| | EMF Compare UML integration | X | X | X | | | | | ||
| | EMF Compare GMF integration | X | X | X | | | | | ||
| | EMF Compare EcoreTools integration | X | X | X | | | | | ||
| | EMF Compare Papyrus integration | X | X | X | | | | | ||
|
|
||
| h2. Reporting Bugs | ||
|
|
||
| There may be errors in the <workspace>/.metadata/.log or even on stdout that can help you track down and problem. | ||
| 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. | ||
|
|
||
| * Bugs or enhancement requests should be reported on the Eclipse bugzilla at https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EMFCompare&component= | ||
| * Check http://www.eclipse.org/emf/compare/support/ for more details on support issues | ||
| * Bugs or enhancement requests should be reported on the GitHub issues for the project at https://github.com/eclipse-emf-compare/emf-compare/issues | ||
| * Check https://www.eclipse.org/emf/compare/support.html for more details on support issues | ||
|
|
||
| h2. Build | ||
|
|
||
| EMF Compare can be built using maven from within the org.eclipse.emf.compare-parent sub-folder of this repository : | ||
|
|
||
| @mvn clean package -Pmars@ | ||
| @mvn clean package -P2022-03@ | ||
|
|
||
| The above example will build the EMF Compare binaries against a Mars platform. Select the appropriate profile according to the platform you wish to install EMF Compare on, one in [mars, luna, kepler, juno, indigo, helios, galileo]. | ||
| The above example will build the EMF Compare binaries against the Eclipse 2022-03 platform. | ||
| Select the appropriate profile according to the platform you wish to install EMF Compare on. | ||
|
|
||
| You can also check the tests using | ||
| You can also execute the tests using | ||
|
|
||
| @mvn verify -Pmars --fail-at-end -Dmaven.test.failure.ignore=true@ | ||
| @mvn verify -P2022-03 --fail-at-end -Dmaven.test.failure.ignore=true@ | ||
|
|
||
| h2. Contributing | ||
|
|
||
| * 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. | ||
| * 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. | ||
| * Make sure you use the proper user information on your git clone's configuration : | ||
| * You need an Eclipse user account. You already have one if you are an Eclipse commiter. Otherwise, use "this form":https://accounts.eclipse.org/user/register?destination=user. | ||
| * Sign the Eclipse Contributor Agreement (ECA) : please go to "your account page":http://www.eclipse.org/contribute/cla , click on "Eclipse Contributor Agreement", and Complete the form. | ||
| * Make sure you use the proper user information on your git configuration : | ||
| ** @$ cd <path/to/repository>@ | ||
| ** @$ git config --local user.name "<Full Name>"@ | ||
| ** @$ git config --local user.email "<your.mail@yourmail.com>"@ | ||
|
|
||
| * Make small logical changes. | ||
| * Provide a meaningful commit message. | ||
|
|
||
| EMF Compare uses gerrit for peer reviews. | ||
| 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 . | ||
| A detailed guide on the commit message's format can be found further down this same page. | ||
|
|
||
| Once properly configured, you will be able to request a review by simply pushing your commit on this new remote. | ||
|
|
||
| A comprehensive contributor guide can also be found on "the project's wiki":https://wiki.eclipse.org/EMF_Compare/Contributor_Guide | ||
| EMF Compare uses github Pull Requests for peer reviews. | ||
| You will need to commit your changes on your own "fork of the EMF Compare repository":https://github.com/eclipse-emf-compare/emf-compare and create Pull Requests from your fork to the main repository. | ||
|
|
||
| A comprehensive contributor guide can also be found on "the project's wiki":https://wiki.eclipse.org/EMF_Compare/Contributor_Guide . |