Skip to content

Commit 41d5e14

Browse files
committed
Update Readme
1 parent 74ccbab commit 41d5e14

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

Readme.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Readme
22
=======
33

4+
[![Build Status](https://github.com/Ergus/ExtraeWin/actions/workflows/cmake.yml/badge.svg?branch=master)](https://github.com/Ergus/ExtraeWin/actions/workflows/cmake.yml)
5+
[![Coverage Status](https://coveralls.io/repos/github/Ergus/ExtraeWin/badge.svg?branch=master)](https://coveralls.io/github/Ergus/ExtraeWin?branch=master)
6+
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
7+
48
This is a very simple multi-platform Instrument based profiler
59
intended to work in multi-threaded systems (not intended for
610
distributed memory systems). For more advanced use cases consider
@@ -32,15 +36,15 @@ function interception in a portable way.
3236
The basic steps are:
3337
--------------------
3438

35-
1. Instrument the code like in the `main.cpp` example code.
39+
1. Instrument the code like in the `tests/tests_profiler.cpp` example code.
3640

3741
The example code includes all the different alternatives to instrument the code.
3842

3943
It is very important to define the `PROFILER_ENABLED` macro **BEFORE** including the
4044
`Profiler.hpp` header.
4145

4246
- PROFILER_ENABLED = 0 (or not defined) don't trace anything
43-
- PROFILER_ENABLED = 1 Emit user defined events (function instrumentation and thread init/stop)
47+
- PROFILER_ENABLED > 0 Emit user defined events (function instrumentation and thread init/stop)
4448

4549
2. Execute your program. This will create a directory called `TRACEDIR_<timestamp>_<pid>` in the current execution path.
4650

@@ -198,7 +202,7 @@ Trace example
198202
The profiler generates one binary trace file per thread. For more details
199203
about the file format see `Parser.cpp`.
200204

201-
For the example provided in `main.cpp` the Paraver trace looks like:
205+
For the example provided in `tests/tests_profiler.cpp` the Paraver trace looks like:
202206

203207
![ParaverTrace](images/Trace.png)
204208

0 commit comments

Comments
 (0)