Skip to content

Getting Started Developing

Volker Schneider edited this page Feb 22, 2014 · 2 revisions

This is a simple step-by-step walkthrough to build and run Maru from source. Make sure you have Java 7 installed on your system.

Eclipse

Download, extract, and start Eclipse for RCP and RAP Developers. These instructions have been tested with Eclipse 4.2 (Juno) and Eclipse 4.3 (Kepler) under Windows and Linux.

Get Maru into your Eclipse workspace

We will clone the Maru source code from its GitHub repository to the local file system and then import app projects into the workspace. All of this can be done from within Eclipse.

Step Screenshot (click to enlarge)
Begin the import process with File -> Import. File -> Import
Select Git -> Projects from Git and click Next. Git -> Projects from Git
Select Clone URI and click Next. Clone URI
Paste Maru's repository location and click Next. Repository location
Select master branch (latest stable version) and maru-next (version currently in development) and click Next. Branch selection
Enter a local path where the repository is going to be cloned to. The path should be outside of your Eclipse workspace directory. Click Next. Repository location
The repository will now be cloned the disk. This may take a while to complete. Choose to import projects from inside the cloned directory and click Next. Import projects
Select all projects and click Finish. Finish import process

Building

After all projects have been imported Eclipse automatically builds them inside the workspace, but with the wrong target platform. The correct target platform must be selected.

Step Screenshot (click to enlarge)
Select the maru.target project and open the indigo.target file. Wait for the Target Definition to be resolved. This may take a while to complete. The defined target platform is downloaded from the internet. Resolving Target Definition
Click Set as Target Platform after the target definition has been resolved. The workspace will be rebuild against the new target platform. Set as Target Platform

Running

Select the maru.product.release project and open the maru.release.product file. Select Launch an Eclipse application to start Maru.
Launch an Eclipse application

Contributing

  1. Fork Maru from its GitHub page.
  2. Import Maru from your own fork into the Eclipse workspace (preferably over SSH instead of HTTPS).
  3. Setup EGit in Eclipse preferences General -> Network Connections -> SSH2 and Team -> Git.
  4. Setup Eclipse Save Actions:
    Save Actions
  5. Setup Eclipse Workspace (note the file encoding and newline delimiter):
    Workspace preferences
  6. Setup source code formatting
  7. Make your changes, commit, push, and create a pull request.

Links

EGit/User Guide/Getting Started
EGit/User Guide - GitHub Tutorial
Git version control with Eclipse (EGit) - Tutorial