Skip to content

Commit

Permalink
update extension's README according to review comments
Browse files Browse the repository at this point in the history
Signed-off-by: Marc Dumais <[email protected]>
  • Loading branch information
marcdumais-work committed Jan 30, 2024
1 parent 3bd0a87 commit d5083dd
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions vscode-trace-extension/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Trace Viewer for VSCode

This extension adds trace viewing capabilities to VSCode and compatible tools.
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.

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)
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)

## Using the extension

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

<a name="trace-server"></a>

## Obtain the Trace Server (Eclipse Trace Compass)

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:
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:

Download the Latest "incubator" build:

- [Linux x86_64](https://download.eclipse.org/tracecompass.incubator/trace-server/rcp/trace-compass-server-latest-linux.gtk.x86_64.tar.gz)
- [other Operating Systems / Architectures](https://download.eclipse.org/tracecompass.incubator/trace-server/rcp/)

Expand Down

0 comments on commit d5083dd

Please sign in to comment.