Skip to content

Commit d5083dd

Browse files
update extension's README according to review comments
Signed-off-by: Marc Dumais <marc.dumais@ericsson.com>
1 parent 3bd0a87 commit d5083dd

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

vscode-trace-extension/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Trace Viewer for VSCode
22

3-
This extension adds trace viewing capabilities to VSCode and compatible tools.
3+
This extension adds trace viewing capabilities to VSCode and compatible tools. It requires running a trace server, that provides trace information. See [below](#obtain-the-trace-server-eclipse-trace-compass) for more details.
44

5-
For information about building this extension from sources, debugging, etc, please see [Developing.md](https://github.com/eclipse-cdt-cloud/vscode-trace-extension/tree/master/README.md)
5+
For information about building this extension from sources, debugging, etc, please see [here (README.md)](https://github.com/eclipse-cdt-cloud/vscode-trace-extension/tree/master/README.md)
66

77
## Using the extension
88

@@ -21,11 +21,14 @@ The `Views` tab shows all the available views for the selected trace. Click on a
2121
[open-output]: https://raw.githubusercontent.com/eclipse-cdt-cloud/vscode-trace-extension/master/doc/images/vscode-trace-extension-001.png
2222
[open-trace]: https://raw.githubusercontent.com/eclipse-cdt-cloud/vscode-trace-extension/master/doc/images/vscode-open-with-trace-viewer-001.png
2323

24+
<a name="trace-server"></a>
25+
2426
## Obtain the Trace Server (Eclipse Trace Compass)
2527

26-
In order to open and view traces, you need a trace server running on the same machine as the trace extension. You can use the Eclipse Trace Compass server:
28+
In order to open and view traces, you need a trace server, that supports TSP (Trace Server Protocol), running on the same machine as this extension. You can use the Eclipse Trace Compass server:
2729

2830
Download the Latest "incubator" build:
31+
2932
- [Linux x86_64](https://download.eclipse.org/tracecompass.incubator/trace-server/rcp/trace-compass-server-latest-linux.gtk.x86_64.tar.gz)
3033
- [other Operating Systems / Architectures](https://download.eclipse.org/tracecompass.incubator/trace-server/rcp/)
3134

0 commit comments

Comments
 (0)