diff --git a/README.md b/README.md index ceb9a2c..ea5d3ff 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docker/theia-app-demo/README.md b/docker/theia-app-demo/README.md index 8a8388d..0c66794 100644 --- a/docker/theia-app-demo/README.md +++ b/docker/theia-app-demo/README.md @@ -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 (\/docker):