From c3de155d41672687aa984b5012ae1b70d40e114e Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Wed, 26 Jun 2019 11:16:51 +0200 Subject: [PATCH] Move readme to root --- README.md | 26 ++++++++++++++++++++++++++ tracetools/README.md | 26 -------------------------- 2 files changed, 26 insertions(+), 26 deletions(-) delete mode 100644 tracetools/README.md diff --git a/README.md b/README.md index e69de29..5d7516e 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,26 @@ +# tracetools + +## Building + +If tracing is not enabled when building, or if LTTng is not found, then this package will not do anything. + +To enable tracing: + +1. Install [LTTng](https://lttng.org/docs/v2.10/#doc-ubuntu): + ``` + $ sudo apt-get install lttng-tools lttng-modules-dkms liblttng-ust-dev + ``` +2. Build with the `WITH_LTTNG` flag: + ``` + $ colcon build --cmake-args " -DWITH_LTTNG=ON" + ``` +3. Check if tracing is enabled (after sourcing): + ``` + $ ros2 run tracetools tracetools_status + ``` + +## Tracing + +By default, the steps above will not lead to trace data being generated, and thus they will have no impact on execution. + +LTTng has to be enabled: TODO mention scripts diff --git a/tracetools/README.md b/tracetools/README.md deleted file mode 100644 index 5d7516e..0000000 --- a/tracetools/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# tracetools - -## Building - -If tracing is not enabled when building, or if LTTng is not found, then this package will not do anything. - -To enable tracing: - -1. Install [LTTng](https://lttng.org/docs/v2.10/#doc-ubuntu): - ``` - $ sudo apt-get install lttng-tools lttng-modules-dkms liblttng-ust-dev - ``` -2. Build with the `WITH_LTTNG` flag: - ``` - $ colcon build --cmake-args " -DWITH_LTTNG=ON" - ``` -3. Check if tracing is enabled (after sourcing): - ``` - $ ros2 run tracetools tracetools_status - ``` - -## Tracing - -By default, the steps above will not lead to trace data being generated, and thus they will have no impact on execution. - -LTTng has to be enabled: TODO mention scripts