update README: upt-tool, upt-gui
Stefan Schuermans

Stefan Schuermans commited on 2020-05-24 13:30:39
Showing 1 changed files, with 23 additions and 4 deletions.

... ...
@@ -18,16 +18,22 @@ is de-initiazlied).
18 18
 
19 19
 UProcTrace is developed on Debian Linux 10 "buster".
20 20
 
21
-Install the prerequisites:
21
+Install the dependencies:
22 22
 
23 23
 ```
24 24
 apt-get install -y build-essential cmake gcc \
25
-                   libprotobuf-c-dev libprotobuf-dev
25
+                   libprotobuf-c-dev libprotobuf-dev \
26 26
                    ninja-build \
27 27
                    protobuf-c-compiler protobuf-compiler \
28 28
                    pylint3 python3 python3-protobuf
29 29
 ```
30 30
 
31
+For the graphical user interface, install the additional dependencies:
32
+
33
+```
34
+apt-get install -y glade libglib2.0-dev libgtk-3-dev python3-gi
35
+```
36
+
31 37
 Change to the directory of this `REAMDE.md` file.
32 38
 
33 39
 Configure a build directory:
... ...
@@ -70,7 +76,14 @@ upt-trace mytrace.proto /usr/bin/printf "trace me"
70 76
 
71 77
 To show the recorded events, run:
72 78
 ```
73
-upt-dump mytrace.proto
79
+upt-tool mytrace.proto dump
80
+```
81
+
82
+## Graphical User interface
83
+
84
+To explore a trace in the graphical user interface, run:
85
+```
86
+<build dir>/upt-gui/upt-gui.py mytrace.proto
74 87
 ```
75 88
 
76 89
 ## Example: Trace Build Process
... ...
@@ -102,7 +116,13 @@ exit
102 116
 ```
103 117
 
104 118
 Show traced information:
119
+
105 120
 ```
106
-upt-dump mytrace.proto
121
+upt-tool mytrace.proto dump
107 122
 ```
108 123
 
124
+To explore the trace in the graphical user interface, run:
125
+
126
+```
127
+<build dir>/upt-gui/upt-gui.py mytrace.proto
128
+```
109 129