Contributing

Setup development environment

Eclipse is used as an IDE here to explain the process.

1. Clone repository first using:

   git clone https://github.com/lttpp/Eemory.git

   Besides, EGit is a good choice to clone Git repository through UI.

2. Unpack Eclipse IDE files into projects:

   Unpack {Eemory_Home}\org.lttpp.eemory\res\eclipse-setup-files.zip into {Eemory_Home}

   Eemory_Home is referencing the root directory of Eemory repository. Then update where needed, e.g., jar name because of thrid party lib upgradation.

   Alternatively, you can generate them by third party Eclipse plug-in as you like.

3. Import projects into Eclipse workspace:

   Click File -> Import... -> Existing Projects into Workspace -> Browse to select cloned projects -> Finish

That is it.

Build instructions

Maven(assume it is installed) is used as an automating build tool here. Project org.lttpp.eemory.build is parent for building. If you have not Maven installed, please go to Apache Maven Project to download and install the latest release first.

1. Change directory to building project org.lttpp.eemory.build:

   cd {Eemory_Home}\org.lttpp.eemory.build

2. Launch Maven build:

   mvn clean package

   And an Eclipse update site(named org.lttpp.eemory.updatesite-x.x.x-SNAPSHOT.zip) will be generated under target folder of update site project org.lttpp.eemory.updatesite.

Alternatively, you can launch Maven build from within Eclipse by M2Eclipse plug-in. You need to first install M2Eclipse plug-in, then right click on Maven POM pom.xml file under project org.lttpp.eemory.build to run as Maven build.