IDEfix product and project setups

This page describes the process of consuming the projects provided by peterkir from Github site.

Mind the copy to clipboard links with the icon

TOC

First-time/virgin installation

This sections describes the initial process on a machine to setup the eclipseInstaller and allow installation of products and projects

Pre-Requisite

Powershell version 3.0 is the minimal supported version. You can test your version in a cmd shell by executing


curl must be available. Test with


open a terminal/shell create a installation directory <eclipseInstallerDir> e.g. mkdir ~/<eclipseInstallerDir>

Installation

  • copy the following line and execute it inside <eclipseInstallerDir>
  • eclipseInstaller window shows up

    • Configuration

  • on the top-right folder icon mark the klib.io Products [required only after initial installation]
  • select from the section at the bottom klib.io Products the product you want to install e.g. IDEfix for OSGi Neon and press Next
  • on the top-right folder icon mark the klib.io Projects [required only after initial installation]
  • (don't select a project) press Next
  • configure the variables and press Next
  • review the tasks and if satisfied press Finish
  • Press "Accept" in the appearing "Licenses" pop-up window
  • IDEfix Eclipse should open up
  • Eclipse Installer can be closed now and IDE with your project is ready.

    • Installing products and/or projects

    You already completed the First-time/virgin installation" and want to install additonal products and/or projects.

    This sections describes the installation of products and projects. Keep in mind that you can also just install a product and skip the project installation.

    1. launch eclipseInstaller
    2. select from the section at the bottomklib.io Products the product you want to install e.g. IDEfix for OSGi Mars and press Next
    3. scroll down to klib.io Projects and check the projects you want to work e.g. example.aspectj on and press Next
    4. configure the following variables and press Next
    5. review the tasks and if satisfied press Finish
    6. Press "Accept" in the appearing "Licenses" pop-up window
    7. IDEfix Eclipse should open up
    8. Eclipse Installer can be closed now and IDE with your project is ready.

    Startup of IDEfix products

    The products you installed are as default all located in a common <instDir>. They have either the product name (product only installation) or the project and branch name.<product_or_project_branch>. You can startup your product via the following cmd lines

    clean-up

    the installation creates (additionally to the <installDir> folder) following directories (~ means %USERPROFILE% on windows)

    1. ~/.eclipse/org.eclipse.oomph.* containing the oomph preferences and user-specified variables
    2. ~/.p2 containing the shared bundle pool for all oomph installations

    Invitation for contributions

    you are invited to consume and/or improve the things you find via a PullRequest;-)

    It consists of 2 phased process, which involves interactions on the github.com website and on your local machine.

    1. GitHub: create a fork of a project
    2. local: execute the engage[.sh|.cmd]
    3. local: select IDEfix product and project you forked on GitHub
    4. local: edit the project inside the IDE instance and commit your changes to your GitHub fork
    5. GitHub: create pull request for the changes you made

    FAQ and Known Issues