Skip to content

Commit

Permalink
README: Fix markdownlint dollar-signs-used warning
Browse files Browse the repository at this point in the history
Fix the markdownlint warning [1] across this file in VS Code.

Remove the related yet extra indentation (few spaces) while being at it.

[1] https://github.com/DavidAnson/markdownlint/blob/v0.24.0/doc/Rules.md#md014

Signed-off-by: Marco Miller <marco.miller@ericsson.com>
  • Loading branch information
marco-miller committed Feb 3, 2022
1 parent 6940f6a commit 51c9468
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ You can find those example applications under `examples/`.
In order to open traces, you need a trace server running on the same machine as the trace extension. You can download the [Eclipse Trace Compass server](https://download.eclipse.org/tracecompass.incubator/trace-server/rcp/?d) or let `yarn` download and run it:

```bash
$ yarn download:server
$ yarn start:server
yarn download:server
yarn start:server
```

You can also build the trace-server yourself using Trace Compass and the Incubator. Take a look at the [instructions here](https://www.eclipse.org/tracecompass/download.html#trace-server).
Expand All @@ -107,15 +107,15 @@ You can also build the trace-server yourself using Trace Compass and the Incubat
From the repo root, run either

```bash
$ yarn start:browser
yarn start:browser
```

and go to `http://localhost:3000`.

Or, run

```bash
$ yarn start:electron
yarn start:electron
```

and use the Electron application.
Expand All @@ -127,19 +127,19 @@ By default, the application expects the trace server to be responding at `http:/
For example, to start the browser example app with a specific URL, one can run

```bash
$ TRACE_SERVER_URL=https://my.trace.server:port/tsp/api yarn start:browser
TRACE_SERVER_URL=https://my.trace.server:port/tsp/api yarn start:browser
```

## Package the Example Theia Trace Viewer Application

It is possible to package the repository's example application with `electron-builder`. After running `yarn` in the repo root, run:

```bash
$ cd examples/electron
$ yarn package
cd examples/electron
yarn package
```

The configured Linux package(s) will be generated in the folder `examples/electron/dist`
The configured Linux package(s) will be generated in the folder `examples/electron/dist`

## Using the trace extension
This section describes how to operate the Theia trace extension to view and analyze traces. The UI and view interactions are preliminary and subject to revisions in the future.
Expand Down

0 comments on commit 51c9468

Please sign in to comment.