Skip to content

Commit

Permalink
[doc][demo images] add mention of the demo images in root README
Browse files Browse the repository at this point in the history
Also improve demo README

Signed-off-by: Marc Dumais <marc.dumais@ericsson.com>
  • Loading branch information
marcdumais-work committed Dec 2, 2024
1 parent f4d681c commit b82d55d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Trace viewer example applications and building blocks that can be used in or with them. Each application integrates either the [Eclipse Theia trace viewer extension](https://www.npmjs.com/package/theia-traceviewer) (npmjs.com) or the [Trace Viewer extension for VSCode](https://open-vsx.org/extension/eclipse-cdt/vscode-trace-extension) (open-vsx.org).

---

💡 _Are you looking for a way to quickly try a "batteries included" trace viewer example application, where everything is setup for you and ready-to-go?_

- ⏩ Build and run one of our [Docker "demo" images](docker/theia-app-demo/README.md#build-the-demo-images)

## Requirements

### General Requirements
Expand Down
6 changes: 3 additions & 3 deletions docker/theia-app-demo/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Resources for the "theia-app-demo" Example docker image

This folder contains the resources, needed to create a "demo" Docker image, based on one of the Theia app images. The demo image includes the necessary extras to easily perform a quick demo or immediately play with the trace viewer: the Eclipse Trace Compass Trace Server and a selection of Tutorial traces.
This folder contains the resources, needed to create "demo" Docker images, based on the Theia app images. A demo image includes the necessary extras to easily perform a quick demo or immediately play with the trace viewer: the Eclipse Trace Compass Trace Server and a selection of Tutorial traces.

## Build the demo images
After connecting to one of the demo appliances with a browser, the trace viewer application should open with the trace server running and a workspace open, containing the tutorial traces, ready to use.

After connecting to either the tate or tave application using a browser, following the instructions below, the app should open with the trace server running and the workspace already selected, containing the tutorial traces, ready to use.
## Build the demo images

Run the following commands from the parent folder (\<repo root\>/docker):

Expand Down

0 comments on commit b82d55d

Please sign in to comment.