Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 3.63 KB

GETTINGSOURCES.md

File metadata and controls

35 lines (28 loc) · 3.63 KB

You could simply clone locally this git repository, but please keep in mind that no generated file is present in the repository, thus if you import the projects manually you will have to run all the MWE2 workflows for all the examples. We suggest instead that you use the following automatic procedure.

This page explains how to easily set up your Eclipse installation and workspace with the source code of the examples of the book.

Remember that you need JDK 8. A JRE will not be enough for the IntelliJ example, since that is based Gradle, and to compile with Gradle you need a JDK.

Set up your Eclipse Workspace

  1. Download and start the Eclipse Installer.
  2. On the initial page, click on the Switch to Advanced Mode button in the top right. Oomph switch to advanced mode Oomph switch to advanced mode
  3. On the Product page, select Eclipse IDE for Eclipse Committers. Important: Make sure you select the JDK installation (not a JRE installation) in the "Java VM" combo (see the note above), otherwise the example based on IntelliJ and Gradle will not compile. Oomph select product.
  4. On the Projects page, click on the "+" icon (Add user projects) in the top right. Add user projects
  5. In the Add User Projects dialog, select Github Projects in the Catalog dropdwon and in the field Resource URIs paste the following URL: https://raw.githubusercontent.com/LorenzoBettini/packtpub-xtext-book-2nd-examples/master/org.example.oomph/XtextBookExamples.setup
  6. Select the "Xtext Book Examples" node and press Next. Select project
  7. Choose your preferred installation settings on the Variables page; in particular, select the checkbox Show all variables and in the dropdwon Xtext Book Examples Github repository make sure you select HTTPS (read-only, anonymous). Variables
  8. Finish the wizard, drink a cup of coffee, the Eclipse distribution will be downloaded and the tooling plug-ins installed (during this stage you will be asked to accept some licences), after that, the new Eclipse instance will be run and the workspace will be set up (including the cloning of the git repository); you may want to close the "Welcome" page when the new Eclipse is started. During this stage, all the Xtext example DSLs will be generated (running all the MWE2 workflows).
  9. Please be patient: many artifacts will have to be downloaded during the set up, including Eclipse plug-ins, Maven artifacts, Gradle distribution and IntelliJ SDK. Please, make sure you have a good Internet connection. Besides that, many MWE2 workflows will be run to generate the Xtext artifacts for all the Example DSLs.

Contribute via Fork

All you need is a GitHub account.

  1. Make sure there is a GitHub issue for what you want to work on.
  2. Announce in the comments section that you want to work on the issue. Also describe the solution you want to implement. To improve the chances for your contribution to be accepted, you'll want to wait for the feedback of the committers.
  3. Implement your change.
  4. Push your changes to your forked repository. It is recommended to create a separate branch, this will make it easier to include the feedback from committers and update your changes.
  5. Create a pull request.

Run a full build locally

TODO