add README-LIVE

Signed-off-by: Julien Desfossez <jdesfossez@efficios.com>

diff --git a/README-LIVE b/README-LIVE
new file mode 100644 (file)
index 0000000..d7b6557
--- /dev/null
+++ b/README-LIVE
@@ -0,0 +1,25 @@
+In order to use the (beta) live tracing features of LttngTop, you need these
+branches :
+
+git clone -b lttngtop-live git://git.dorsal.polymtl.ca/~jdesfossez/lttng-tools
+git clone -b lttngtop-live git://git.dorsal.polymtl.ca/~jdesfossez/babeltrace
+
+The only difference between these branches and the master branch is that they
+export an additional library that is used by lttngtop to do live tracing.
+
+You have to compile and install lttng-tools before babeltrace since there are
+dependencies on the library exposed by this special lttng-tools in babeltrace
+for live mmap buffer consuming.
+
+Then you can compile and use the live branch of LttngTop :
+git clone -b live git://git.lttng.org/lttngtop.git
+
+Once everything is installed, you can start as root lttng-sessiond and use
+lttngtop (as root or from a user part of the "tracing" group).
+
+Note: if lttng-sessiond has been used to record a trace before starting
+lttngtop (normal lttng use-case), you need to restart it because it
+automatically spawned a consumer that prevents lttngtop from registering its
+own consumer. The same applies when you finish using lttngtop, you need to
+restart the lttng-sessiond daemon to allow others to record traces again. This
+is a know problem of integration that will be fixed.