tmf: Update user guide for time offsetting
[deliverable/tracecompass.git] / README
diff --git a/README b/README
index c77714d5cd0492c54a8fc42515b7bc8e2076e91c..625ab39441ce4f1a7146ea13bdfa9dd2abe277d6 100644 (file)
--- a/README
+++ b/README
@@ -6,6 +6,7 @@ org.eclipse.linuxtools.ctf.*          Common Trace Format (CTF) reader library
 org.eclipse.linuxtools.gdbtrace.*     Support for reading and viewing GDB traces
 org.eclipse.linuxtools.lttng2.*       LTTng 2.x integration
 org.eclipse.linuxtools.tmf.*          Tracing and Monitoring Framework
+org.eclipse.linuxtools.statesystem.*  State System library
 org.eclipse.linuxtools.tracing.rcp.*  Code specific to the RCP version
 
 See the plugins.svg file for a diagram showing the dependencies between the
@@ -18,19 +19,34 @@ http://wiki.eclipse.org/Linux_Tools_Project/LTTng_Eclipse_Plug-in_Development_En
 
 
 
-To build the plugins manually, first cd to the directory then invoke Maven:
-$ cd lttng/
+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
 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 'mvn' command:
 $ mvn clean install -PtracingRcp -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.linuxtools.tracing.rcp.product/target/products
+
+
+To build a local p2 update site
+$ mvn clean install -PbuildUpdateSite
+
+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 -PbuildUpdateSite "-DsiteDestination=<package destination>"
+
+where <package destination> is the absolute path to destination directory on
+your disk.
 
This page took 0.026033 seconds and 5 git commands to generate.