ctf: Avoid direct dependency from the lttng plugins to the ctf.core one

[deliverable/tracecompass.git] / README

diff --git a/README b/README
index db8d407b10c88becd8401a34ea42dc45089d0dfd..0a786ea5583e3c5917a831dc4184ce0d2c3ec889 100644 (file)
--- a/README
+++ b/README
@@ -1,30 +1,28 @@
-This directory contains the source code for the LTTng integration plugins for
-Eclipse, which includes the generic Tracing and Monitoring Framework (TMF).
+This source tree contains the source code for the Trace Compass plugins for
+Eclipse.
 
 The plugins are categorized as follows:
-org.eclipse.linuxtools.ctf.*          Common Trace Format (CTF) reader library
-org.eclipse.linuxtools.gdbtrace.*     Support for reading and viewing GDB traces
-org.eclipse.linuxtools.lttng*         LTTng 2.x integration
-org.eclipse.linuxtools.tmf.*          Tracing and Monitoring Framework
-org.eclipse.linuxtools.tracing.rcp.*  Code specific to the RCP version
+org.eclipse.tracecompass.ctf.*          Common Trace Format (CTF) reader library
+org.eclipse.tracecompass.gdbtrace.*     Support for reading and viewing GDB traces
+org.eclipse.tracecompass.lttng2.*       LTTng 2.x integration
+org.eclipse.tracecompass.tmf.*          Core framework
+org.eclipse.tracecompass.statesystem.*  State System library
+org.eclipse.tracecompass.rcp.*  Code specific to the RCP version
 
+See the plugins.svg file for a diagram showing the dependencies between the
+different plugins.
 
-To set up the environment to build TMF from within Eclipse, see this wiki page:
-http://wiki.eclipse.org/Linux_Tools_Project/LTTng_Eclipse_Plug-in_Development_Environment_Setup
 
+To set up the environment to build Trace Compass from within Eclipse, see this
+wiki page:
+http://wiki.eclipse.org/Trace_Compass/Development_Environment_Setup
 
 
 
-To build it using Maven, you first need to build the Linux Tools licensing
-feature (starting from the root of the source tree):
-$ cd releng/org.eclipse.linuxtools.license-feature
-$ mvn clean install
-Then you can build the LTTng plugins:
-$ cd ../../lttng
-$ mvn clean install
 
-As long as you don't clear the Maven reactor cache (in ~/.m2), you should not
-need to rebuild the licensing feature.
+To build the plugins manually using Maven, simply run the following command from
+the top-level directory:
+$ mvn clean install
 
 
 The default command will compile and run the unit tests. Running the tests can
@@ -32,10 +30,24 @@ take some time, to skip them you can append "-Dmaven.test.skip=true" to the
 'mvn' command:
 $ mvn clean install -Dmaven.test.skip=true
 
-The RCP is not built by default, to build it you need to add "-PtracingRcp" to
+
+The RCP is not built by default, to build it you need to add "-Pbuild-rcp" to
 the 'mvn' command:
-$ mvn clean install -PtracingRcp -Dmaven.test.skip=true
+$ mvn clean install -Pbuild-rcp -Dmaven.test.skip=true
 
 This will build the RCP for all supported architectures. The resulting archives
-will be placed in lttng/org.eclipse.linuxtools.tracing.rcp.product/target/products
+will be placed in org.eclipse.tracecompass.rcp.product/target/products
+
+
+To build a local p2 update site
+$ mvn clean install -Pbuild-update-site
+
+This will place the p2 update site under the default location
+/var/www/tools/tracecompass/nightly/
+
+To change the package location, use:
+$ mvn clean install -Pbuild-update-site "-DsiteDestination=<package destination>"
+
+where <package destination> is the absolute path to destination directory on
+your disk.