Commit cbff7f73 authored by Patrik Meijer's avatar Patrik Meijer
Browse files

Minor phrasing

parent 08d8e749

README.md

+3 −3
Changes for README.md: 3 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ Visit `http://localhost:4000` from your browser. 
### Docker Images

If you haven't already, [install docker](https://docs.docker.com/engine/install/ubuntu/) - this has been tested with `Docker version 25.0.3, build 4debf41` on `Ubuntu 22.04`.



The fasted way to get started is to use the monolithic docker image that contains all the necessary back-end services for the provided example. For the user-interface you can either install [install vscode](https://code.visualstudio.com/download) directly on your machine or use the `caid-front-end` docker image that is based on [theia](https://theia-ide.org/) and already prepared with the extensions. 

The fasted way to get started is to use the monolithic docker image, `caid-tools`, that contains all the necessary back-end services for the provided example. For the user-interface you can either [install vscode](https://code.visualstudio.com/download) directly on your machine or use the `caid-front-end` docker image that is using [theia](https://theia-ide.org/) (a server/web-browser based version of vscode) and already prepared with the extensions. 



![Docker services](examples/images/docker-services.png)
@@ -65,7 +65,7 @@ The following services are running within the monolithic caid-tools container (s 
- **gitea** is [a free, open source, git collaboration platform](https://about.gitea.com/) that hosts the git-repositories and manages the webhooks, etc.



### Front-end/User Interface

For the user interface you can either [install vscode](https://code.visualstudio.com/download) and then install the vscode extensions below (click link) or use the `caid-front-end` docker image below that is based on [theia](https://theia-ide.org/) and already prepared with the extensions.

For the user interface you can either [install vscode](https://code.visualstudio.com/download) and then install the vscode extensions below (click link) or use the `caid-front-end` docker image below that is using [theia](https://theia-ide.org/) and already prepared with the extensions.



- [Depi Browser](vscode:extension/vu-isis.depi)

- [WebGME Client](vscode:extension/vu-isis.webgme-depi)
@@ -99,7 +99,7 @@ To view the current state of the example system press `Ctrl/Cmd + Shift + P` and 
#### Reveal Resources

With _Resources_ added to Depi, it is possible to navigate (granted the _Tool_ supports) to the actual implementation of that resource. For example, by selecting the Vehicle in the `webgme` _Resource Group_. 

![WebGME Reveal](examples/images/depi-blackboard-webgme.png)

Expanding the side-menu (click the three lines to right-corner and then clicking the boxed arrow in the top right corner the Vehicle model is opened up in the WebGME model editor.

Expanding the side-menu click the three lines to right-corner and then clicking the boxed arrow in the top right corner the Vehicle model is opened up in the WebGME model editor.

![WebGME Reveal](examples/images/webgme-model.png)

You can do the same thing for the git-based _Resources_ and if the repository is cloned locally it will open up the file in the vscode-editor (or expand and highlight the folder in the explorer).