# HG changeset patch # User Omair Majid # Date 1390318432 18000 # Node ID c9a209ff2ee3fea2675dd9d8b7cc4b543ea5d463 # Parent dd6308fbfe628892c3db64562433884b53995dbf Add more information to HACKING diff -r dd6308fbfe62 -r c9a209ff2ee3 HACKING.md --- a/HACKING.md Mon Jan 20 17:49:33 2014 -0500 +++ b/HACKING.md Tue Jan 21 10:33:52 2014 -0500 @@ -7,6 +7,7 @@ package/module/directory name. This is just a short form of `com.redhat.thermostat.tools.eclipse`. + Building from Source -------------------- Use maven to build: @@ -31,25 +32,32 @@ Eclipse provides a graphical UI over `META-INF/MANIFEST.MF`, `plugin.xml` and `build.properties` files. +It's a very good idea to install `m2e-core` plugin in ecipse so you can import +the maven project into eclipse directly. + + Layout ------ The root source directory contains the following directories. - - c.r.t.t.e.plugin + - `c.r.t.t.e.plugin` This contains the main implementation of the plugin. - - c.r.t.t.e.plugin-feature - This directory contains an eclipse *feature* for the project. + - `c.r.t.t.e.plugin-feature` + This directory contains an eclipse *feature* for the project. You probably + dont want to modify this. - - c.r.t.t.e.plugin-p2-repo + - `c.r.t.t.e.plugin-p2-repo` This directory contains code to generate a repository which can be used to - install the plugin when it's built. + install the plugin when it's built. You probably dont want to modify + anything in here. - - c.r.t.t.e.plugin.tests + - `c.r.t.t.e.plugin.tests` This directory contains (unit) tests for the plugin. Code here is run on every build. This code is only used at build time and not used to populate the repository. + Tests ----- It's a good idea to add a unit test for every new class introduced.