Jump to: navigation, search

Triquetrum/Building From Sources

There are at least two ways to get started with Triquetrum:

  1. Building from sources, which is for people who will collaborate on Triquetrum by recompiling and submitting changes.
  2. Downloads, which is for people who want to use Triquetrum without recompiling.

This page discusses how to build from sources and how to prepare for contributing to Triquetrum.

Current version info

(July 2017) : We are using Eclipse Oxygen as development IDE and using the latest Oxygen milestone as Triquetrum target platform. Neon and pre-Neon versions may work as well as IDE, but may have limits to maintain e.g. EMF Forms viewmodels for Triquetrum.

Using the Triquetrum development Oomph setup

This approach allows you to start almost from scratch (with a JDK 1.8 and a Git client installed already), and to obtain a ready-for-use Triquetrum development environment including :

This involves following steps :

1. Download and start the Eclipse Installer

2. In the Eclipse Installer, click on the menu icon with the exclamation point in the upper right and select Advanced Mode.

TriquetrumEclipseInstallerSelectAdvancedMode.png

Under macOS, if the menu is not active, see Bug 521439 - Eclipse Installer: Mac OS X: Exclamation point menu is not always active

3. In the Product window, select your desired Eclipse installation package (typically Eclipse for RCP and RAP developers but also Eclipse Modeling tools can be used) and click Next.

OomphSetup1.JPG

4. In the Projects window, click on the green plus (+) sign to the right of the entry widget at top. The Add User Projects window will appear. In that window, in Catalog, select "Eclipse Projects". Then, in the Resource URIs field, enter the URL of the setup file:

 https://raw.githubusercontent.com/eclipse/triquetrum/master/setups/org.eclipse.triquetrum.developer.setup/TriquetrumDevelopment.setup

Click on OK. (TODO : we need to add our setup to the standard list at Eclipse).

OomphSetup2.JPG

If you get a window about an invalid URI, then it could be that you clicked on the green plus (+) in the Product window instead of the Projects window. See Bug #252 Triquetrum Eclipse installer: Error Adding Products

5. Select the "Triquetrum development" setup and click Next

TriquetrumOomphProjectsSelectTriquetrum.png

6. Check and adapt the setup variables for e.g. root installation folder, git clone location, github account info. Remark that the git SSH repository URL may cause issues on Windows 10 when using Plink/Pageant, blocking until a timeout of 15 minutes. Using the HTTPS URL should work fine and immediately. Click Next and then Finish to let the installer do its thing to download the Eclipse RCP package and extra plugins and to start your new Eclipse instance.

OomphSetup3.JPG

7. Accept any unsigned content:

TriquetrumEclipseInstallerAcceptUnsignedContent.png

See Bug #70 Signing the build artifacts.

8. When Eclipse is starting, you will see a progress indication at the bottom right for the startup tasks of the Oomph setup for Triquetrum. This will clone the Triquetrum repository, apply default Java code formatting preferences, set the target platform and prepare a Mylyn tasks-query on our Github issues.

OomphSetup4.JPG

9. Wait some minutes (resolving and setting the target can take some time) and your workspace should be error-free and ready to run/debug/develop Triquetrum. You're all set to start contributing to Triquetrum! See Running, below.

Manual setup

Check Out the Repo

Use Eclipse to check out the repo.

  1. Install Eclipse for RCP and RAP Developers. Other versions may work. These instructions were tested using Neon under Mac OS X and Windows 10.
  2. Start Eclipse. Create a new workspace. You may need to close the Welcome tab by clicking on the X.
  3. Window -> Show View -> Other -> Git -> Git Repositories
  4. Click on "Clone a Git repository"
  5. Click on "Clone URI", then Next
  6. Enter the URI https://github.com/eclipse/triquetrum/
  7. In the Branch Selection window, keep the defaults that include the Master branch and other branches, then click Next.
  8. In the Local Destination window, select Finish.

Importing Projects

In the Git Repositories tab, expand the triquetrum tab, right click on Working Tree and select Import Projects.

1. Keep "Import existing Eclipse projects" selected, click Next.

2. Then click Finish.

Building

The build will show lots of errors. Don't panic.

1. Expand org.eclipse.triquetrum.target.platform and double click on "org.eclipse.triquetrum.target.platform.target"

TriquetrumGettingStartedTriqTarget.png

2. The target will build. See the bottom right for the status. It may take a minute or two to build.

3. In org.eclipse.triquetrum.target.platform.target tab, Target Definition pane, click on Set as Target Platform.

TriquetrumGettingStartedSetTargetAsPlatform.png

4. You should have a workspace without errors now.

Note that org.eclipse.triquetrum.target.platform/org.eclipse.triquetrum.target.platform.target is created from the org.eclipse.triquetrum.target.platform.tpd file. The first time Triquetrum is built it is typically not necessary to update the .target or .tpd files. However, if you later want to update the .target file, see Target Platform Definition.

Running

1. Under org.eclipse.triquetrum.repository, open Triquetrum.product in the Product Configuration Editor

Triquetrum RunFromProduct.JPG

2. In the Overview tab, under Testing or at the top right mini-toolbar, click on Launch an Eclipse Application.

Triquetrum RunFromProduct2.JPG

The application should start up.

3. See Triquetrum/Getting Started for how to use Triquetrum.