changeset 88:c9a209ff2ee3

Add more information to HACKING
author Omair Majid <omajid@redhat.com>
date Tue, 21 Jan 2014 10:33:52 -0500
parents dd6308fbfe62
children 67d58773e96e
files HACKING.md
diffstat 1 files changed, 14 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- 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.