From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Thu, 18 Feb 2021 21:52:06 +0000 (-0500)
Subject: Improve README.md
X-Git-Url: http://git.lttng.org/?p=lttng-trace.git;a=commitdiff_plain;h=93f41cd5939172b661e91b22388c84c005b3e43f

Improve README.md

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/README.md b/README.md
index 4a39fa5..4772b48 100644
--- a/README.md
+++ b/README.md
@@ -3,4 +3,52 @@ LTTng trace - Trace command execution and its sub-processes
 
 by Mathieu Desnoyers
 
-TODO
+
+Building
+--------
+
+### Prerequisites
+
+This source tree is based on the Autotools suite from GNU to simplify
+portability. Here are some things you should have on your system in order to
+compile the Git repository tree:
+
+  - [GNU Autotools](http://www.gnu.org/software/autoconf/)
+    (**Automake >= 1.10**, **Autoconf >= 2.50**,
+    **Autoheader >= 2.50**;
+    make sure your system-wide `automake` points to a recent version!)
+
+### Building steps
+
+If you get the tree from the Git repository, you will need to run
+
+    ./bootstrap
+
+in its root. It calls all the GNU tools needed to prepare the tree
+configuration.
+
+To build and install, do:
+
+    ./configure
+    make
+    sudo make install
+
+### Usage
+
+Make sure lttng-tools, lttng-ust, and lttng-modules are installed on
+your system. Make sure your user is part of the `tracing` group.
+
+As root, launch the LTTng session daemon:
+
+    lttng-sessiond -d
+
+As user, run:
+
+    lttng-trace COMMAND
+
+Where COMMAND is the command you want to trace. Follow the instructions
+on standard error.
+
+For detailed help, run:
+
+    lttng-trace --help