Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Lyo/AdaptorCodeGeneratorWorkshop/EclipseSetup"

(Necessary Eclipse Installations)
Line 1: Line 1:
= Eclipse Setup =
+
= Lyo Code Generator Setup =
  
The following steps need only be performed once to setup your Eclipse environment.  
+
== Installation ==
 +
The easiest way to install the Lyo Code Generator is via the update-site http://jadelkhoury.github.io/lyo.codegen/downloads/.
  
== Necessary Eclipse Installations ==
+
The code generator is known to work on Eclipse Kepler and Luna.
The code generator is known to work on both Eclipse Kepler and Luna.  
+
  
1. Unless already installed, you need to first install a JDK (at least version 7 is necessary)
+
# Select '''''Help --> Install New Software...'''''
 +
# Set '''''Work With:''''' to the update site http://jadelkhoury.github.io/lyo.codegen/downloads/
 +
# Select the '''''Lyo Code Generator''''' feature.
 +
# Proceed with the installation steps.
 +
#* '''Note''': You will receive a warning that the software contains unsigned content. Press ''OK'' to proceed.
  
2. install one of the following (using Eclipse’s “'''Help --> Install new software'''” dialog)
+
=== General Tips for OSLC4J development ===  
=== Eclipse Standard Kepler (4.3.1) ===  
+
* Eclipse Git Team Provider (EGit); version 3.1.0
+
* Maven Integration for Eclipse (m2e); version 1.4.0
+
* Acceleo; version 3.4.1
+
* Eclipse Java EE Developer Tools; version 3.5.1
+
* Eclipse Java Web Developer Tools; version 3.5.1
+
* EMF Facet SDK (Incubation); version 0.3.1
+
* EMF - Eclipse Modeling Framework SDK; version 2.9.1
+
  
=== Eclipse Standard Luna (4.4.2) ===
+
# Unless already installed, you need to first install a JDK (at least version 7 is necessary)
* Maven Integration for Eclipse (m2e); version 1.5.1
+
# Install your preferred Eclipse distribution. Which distribution to use?
* Acceleo; version 3.5.1
+
#* [https://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/lunasr2 Eclipse IDE for Java EE Developers] seems to cover the necessary [https://wiki.eclipse.org/Lyo/prereqs prerequisites for Building Lyo Projects].
* Eclipse Java EE Developer Tools; version 3.6.3
+
#* [https://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/lunasr2 Eclipse IDE for Java Developers] can be used, together with the following 2 additional plugins:
* Eclipse Java Web Developer Tools; version 3.6.3
+
#** ''Eclipse Java EE Developer Tools''
* EMF Facet SDK (Incubation); version 0.4.2
+
#** ''Eclipse Java Web Developer Tools''
* EMF - Eclipse Modeling Framework SDK; version 2.10.2
+
# Once Eclipse is installed, you need to make sure the '''JAVA_HOME''' environment variable is set to the installed JDK (instead of the default JRE).
 
+
== Eclipse Environment Setup ==
+
The following steps need only be done once per Eclipse environment setup.
+
 
+
# Clone the OSLC Core repository
+
## git clone git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.core.git
+
## cd org.eclipse.lyo.core
+
# View the Git repository in Eclipse
+
## Open the Git Repositories perspective in Eclipse  
+
## Click the “Add an existing local Git repository” icon.
+
## Select the “org.eclipse.lyo.core” repository
+
## The repository should now show up in your Git Repositories view
+
# Import the Eclipse projects from the Git repository
+
## In the Git Repositories view, right click the org.eclipse.lyo.core repository and select Import Projects
+
## Select the Import Existing Projects wizard and click next
+
## Select the “adaptor_model” & “codegenerator” projects.
+
# Make sure '''JAVA_HOME''' environment variable is set to [at least] a JDK 1.6.
+
## JRE of eclipse needs to use JRE in the JDK dir
+
 
## Select '''''Window-->Preferences'''''
 
## Select '''''Window-->Preferences'''''
 
## Select '''''Java-->Installed JREs'''''
 
## Select '''''Java-->Installed JREs'''''
## Click '''''Add…'''''
+
## Click '''''Add...'''''
 
## In the new window that appears,  
 
## In the new window that appears,  
 
### choose '''''Standard VM''''' as JRE Type  
 
### choose '''''Standard VM''''' as JRE Type  
Line 53: Line 31:
 
## Back to the preferences screen
 
## Back to the preferences screen
 
### select the old JRE  
 
### select the old JRE  
### click Remove
+
### click '''''Remove'''''
 
### check the newly added JDK and  
 
### check the newly added JDK and  
 
### click '''''OK'''''.
 
### click '''''OK'''''.
 +
 +
== Optional Installations ==
 +
The generator plugin contains a built-in EMF editor to create and manipulate the OSLC adaptor model. Standard EMF editors can equally be used as well. Example standard plugins that can be installed (using Eclipse's '''''Help --> Install new software''''' dialog) are:
 +
* '''EMF Facet SDK''' – providing the editor ''EMF Facet Model Browser''
 +
* '''EMF - Eclipse Modeling Framework SDK''' – providing the editor ''Sample Reflective Ecore Model Editor''
 +
 +
 +
== Working with the source code ==
 +
If you desire to work with the source code of the generator, the following additional steps are required:
 +
# Install the following plugins
 +
## Acceleo
 +
## A suitable EMF editor available through one of the Eclipse plugins ''"EMF Facet SDK"'' or ''"EMF - Eclipse Modeling Framework SDK"'' (See the optional installations above).
 +
# Clone the OSLC Core repository git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.core.git
 +
# View the Git repository in Eclipse
 +
## Open the Git Repositories perspective in Eclipse
 +
## Click the '''''Add an existing local Git repository''''' icon.
 +
## Select the ''org.eclipse.lyo.core'' repository
 +
## The repository should now show up in your Git Repositories view
 +
# Import the necessary Eclipse projects from the Git repository
 +
## In the Git Repositories view, right click the org.eclipse.lyo.core repository and select '''''Import Projects'''''
 +
## Select the '''''Import Existing Projects''''' wizard and click '''''next'''''
 +
## Select the ''adaptor_model'' & ''codegenerator'' projects.

Revision as of 06:04, 23 December 2015

Lyo Code Generator Setup

Installation

The easiest way to install the Lyo Code Generator is via the update-site http://jadelkhoury.github.io/lyo.codegen/downloads/.

The code generator is known to work on Eclipse Kepler and Luna.

  1. Select Help --> Install New Software...
  2. Set Work With: to the update site http://jadelkhoury.github.io/lyo.codegen/downloads/
  3. Select the Lyo Code Generator feature.
  4. Proceed with the installation steps.
    • Note: You will receive a warning that the software contains unsigned content. Press OK to proceed.

General Tips for OSLC4J development

  1. Unless already installed, you need to first install a JDK (at least version 7 is necessary)
  2. Install your preferred Eclipse distribution. Which distribution to use?
  3. Once Eclipse is installed, you need to make sure the JAVA_HOME environment variable is set to the installed JDK (instead of the default JRE).
    1. Select Window-->Preferences
    2. Select Java-->Installed JREs
    3. Click Add...
    4. In the new window that appears,
      1. choose Standard VM as JRE Type
      2. click Next.
      3. As JRE home choose the installation dir of your JDK 1.6
      4. click Finish.
    5. Back to the preferences screen
      1. select the old JRE
      2. click Remove
      3. check the newly added JDK and
      4. click OK.

Optional Installations

The generator plugin contains a built-in EMF editor to create and manipulate the OSLC adaptor model. Standard EMF editors can equally be used as well. Example standard plugins that can be installed (using Eclipse's Help --> Install new software dialog) are:

  • EMF Facet SDK – providing the editor EMF Facet Model Browser
  • EMF - Eclipse Modeling Framework SDK – providing the editor Sample Reflective Ecore Model Editor


Working with the source code

If you desire to work with the source code of the generator, the following additional steps are required:

  1. Install the following plugins
    1. Acceleo
    2. A suitable EMF editor available through one of the Eclipse plugins "EMF Facet SDK" or "EMF - Eclipse Modeling Framework SDK" (See the optional installations above).
  2. Clone the OSLC Core repository git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.core.git
  3. View the Git repository in Eclipse
    1. Open the Git Repositories perspective in Eclipse
    2. Click the Add an existing local Git repository icon.
    3. Select the org.eclipse.lyo.core repository
    4. The repository should now show up in your Git Repositories view
  4. Import the necessary Eclipse projects from the Git repository
    1. In the Git Repositories view, right click the org.eclipse.lyo.core repository and select Import Projects
    2. Select the Import Existing Projects wizard and click next
    3. Select the adaptor_model & codegenerator projects.

Back to the top