Fix time graph widget initialization

[deliverable/tracecompass.git] / README.md

diff --git a/README.md b/README.md
index 06c9ba97a89e9485c61002f1518b4d47e5ca20af..432836a6bf87f0854b22927e7a90c03c78f5f76f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,7 +34,10 @@ wiki page:
 Compiling manually
 ------------------
 
-To build the plugins manually using Maven, simply run the following command from
+The Maven project build requires version 3.3 or later. It can be downloaded from
+<http://maven.apache.org> or from the package management system of your distro.
+
+To build the project manually using Maven, simply run the following command from
 the top-level directory:
 
     mvn clean install
@@ -45,16 +48,11 @@ take some time, to skip them you can append `-Dmaven.test.skip=true` to the
 
     mvn clean install -Dmaven.test.skip=true
 
-The RCP is not built by default, to build it you need to add `-Pbuild-rcp` to
-the `mvn` command:
-
-    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 `rcp/org.eclipse.tracecompass.rcp.product/target/products`.
+Stand-alone application (RCP) packages will be placed in
+`rcp/org.eclipse.tracecompass.rcp.product/target/products`.
 
-These commands will also build the p2 update site, which will be placed in
-`releng/org.eclipse.tracecompass.releng-site/target/repository`.
+The p2 update site, used for installation as plugins inside Eclipse, will be
+placed in `releng/org.eclipse.tracecompass.releng-site/target/repository`.
 
 
 Maven profiles and properties
@@ -72,20 +70,26 @@ the build system. You can set them by using `-P[profile name]` and
   stable platform. To use the staging target for example, use
   `-Dtarget-platform=tracecompass-eStaging`.
 
+* `-Dskip-automated-ui-tests`
+
+  Skips the automated UI integration tests. Not required when using
+  `-Dmaven.test.skip=true`, which already skips all the tests.
+
+* `-Dskip-rcp`
+
+  Skips building the RCP archives and related deployment targets. Only works in
+  conjunction with `-Dskip-automated-ui-tests`, due to a limitation in Maven.
+
 * `-Pctf-grammar`
 
   Re-compiles the CTF grammar files. This should be enabled if you modify the
   `.g` files in the `ctf.parser` plugin.
 
-* `-Pbuild-rcp`
-
-  Builds the RCP archives. Refer to the previous section for details.
-
 * `-Prun-custom-test-suite`
 
   Runs a test suite present in `releng/org.eclipse.tracecompass.alltests`. The
   test suite to run has to be defined by `-DcustomTestSuite=[name]`, for example
-  `-DcustomTestSuite=RunAllCoreTests`.
+  `-DcustomTestSuite=RunAllPerfTests`.
 
 * `-Pdeploy-rcp`
 
@@ -93,7 +97,6 @@ the build system. You can set them by using `-P[profile name]` and
   the RCP-specific update site, to the paths specified by
   `-DrcpDestination=/absolute/path/to/destination` and
   `-DrcpSiteDestination=/absolute/path/to/destination`, respectively.
-  Must be used with `-Pbuild-rcp`!
 
 * `-Pdeploy-update-site`