Skip to content

Commit 7035c4a

Browse files
authored
Merge pull request #26 from talex5/opam
Update README now that eio-trace is released
2 parents d32a20a + 98ccd19 commit 7035c4a

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ eio-trace can be used to record and display traces of programs using the [Eio][]
88
To install eio-trace:
99

1010
```
11-
git clone --recursive https://github.com/ocaml-multicore/eio-trace.git
12-
cd eio-trace
13-
dune build
11+
opam install eio-trace
1412
```
1513

1614
### macOS
@@ -46,13 +44,13 @@ Update the version number to match the currently installed version of libffi.
4644
To run an Eio program and display the trace:
4745

4846
```
49-
dune exec -- eio-trace run -- myprog ...
47+
eio-trace run -- myprog ...
5048
```
5149

5250
You might like to start by tracing the example that comes with eio-trace:
5351

5452
```
55-
dune build && dune exec -- eio-trace run -- ./_build/default/examples/net/main.exe
53+
dune build && eio-trace run -- ./_build/default/examples/net/main.exe
5654
```
5755

5856
<p align='center'>
@@ -64,7 +62,7 @@ Scrolling with the mouse or touchpad will zoom in or out of the diagram.
6462
To record a trace:
6563

6664
```
67-
dune exec -- eio-trace record -f trace.fxt -- myprog ...
65+
eio-trace record -f trace.fxt -- myprog ...
6866
```
6967

7068
This runs `myprog ...` with the `OCAML_RUNTIME_EVENTS_START` environment variable set, which causes it to record events to a ring buffer.
@@ -75,13 +73,13 @@ The trace can be viewed using generic tools such as [Perfetto][], but eio-trace'
7573
as it takes advantage of Eio's structured concurrency:
7674

7775
```
78-
dune exec -- eio-trace show trace.fxt
76+
eio-trace show trace.fxt
7977
```
8078

8179
To convert a trace to SVG format:
8280

8381
```
84-
dune exec -- eio-trace render trace.fxt
82+
eio-trace render trace.fxt
8583
```
8684

8785
You can also use `--format=png` for PNG output.

0 commit comments

Comments
 (0)