prepare the 0.3 release

[lttngtop.git] / README

diff --git a/README b/README
index 4bb510cae2b7cf94f7dbc14daa7d5390ad05e3ce..bceb058f43da0a06c2301a66b2bce802ce78991c 100644 (file)
--- a/README
+++ b/README
@@ -1,40 +1,18 @@
 LTTngTop
-Julien Desfossez <julien.desfossez@polymtl.ca>
-August 2011
+Julien Desfossez <jdesfossez@efficios.com>
+June 2015
 
 Lttngtop is an ncurses interface for reading and browsing traces recorded by
 the LTTng tracer and displaying various statistics.
-As of now, the cpu usage and perf counters are displayed. This version currently
-only supports offline traces, but a live version is in alpha and will be
-available for testing soon.
+As of now, the cpu usage, per file/process I/O bandwidth and perf counters are
+displayed. This release is the first one that handles live sessions as well as
+offline sessions.
 
 USAGE
 -----
 
-Record a trace with LTTng 2.0 with at least the sched_switch event, and the pid,
-procname, tid, ppid contexts. To have the perftop view working you can enable
-any number of perf contexts (depending on your hardware).
-For the iotop view, you need to have some syscall events : sys_read, sys_write
-and exit_syscall.
-
-Once your trace is recorded, you can use lttngtop this way :
-$ lttngtop /path/to/your/trace
-
-Make sure you have read permissions on the whole directory.
-
-EXAMPLE
--------
-
-# lttng create lttngtop
-# lttng enable-event -k sched_switch
-# lttng add-context -k -t pid -t procname -t tid -t ppid -t perf:cache-misses \
-       -t perf:major-faults -t perf:branch-load-misses
-# lttng start
-# ...do stuff...
-# lttng stop
-# lttng destroy
-
-$ lttngtop $HOME/lttng-traces/lttngtop-...
+The manpage located in the doc folder of this source tree documents the usage
+of LTTngTop.
 
 BUILDING
 --------
@@ -47,7 +25,7 @@ BUILDING
 DEPENDENCIES
 ------------
 
-To compile Babeltrace and lttngtop, you will need:
+To compile Babeltrace and lttngtop, you need:
 
        gcc 3.2 or better
        libc6 development librairies
@@ -61,7 +39,12 @@ To compile Babeltrace and lttngtop, you will need:
          (Fedora : popt)
        ncurses development libraries
          (Debian : libncurses5-dev)
-       babeltrace development library
+       babeltrace = 1.2.3 development library
+
+To use the local live tracing feature, you need:
+       lttng-tools >= 2.4
+       lttng-modules >= 2.4
+       babeltrace = 1.2.4
 
 For developers using the git tree:
 
@@ -73,8 +56,6 @@ compile the git repository tree :
   (make sure your system wide "automake" points to a recent version!)
 - GNU Libtool >=2.2
   (for more information, go to http://www.gnu.org/software/autoconf/)
-- Flex >=2.5.35.
-- Bison >=2.4.
 
 If you get the tree from the repository, you will need to use the "bootstrap"
 script in the root of the tree. It calls all the GNU tools needed to prepare the