Skip to content
This repository was archived by the owner on Nov 30, 2023. It is now read-only.

Commit 9007455

Browse files
committed
Update README.md
1 parent c31bcef commit 9007455

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

containers/plantuml/README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,36 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | PlantUML |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this and other definitions in your project](../../README.md#using-a-definition). There are no addtional steps required.
15+
This definition does not require any special steps to use. Just follow these steps:
1616

17-
### Try it
17+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
1818

19-
1. Run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of this entire folder.
20-
2. The container will build and VS Code will connect.
21-
3. Open `sample.plantuml` in the `test-project` folder and hit Alt-D.
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the PlantUML definition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/plantuml/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
32+
33+
## Testing the definition
34+
35+
This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps:
36+
37+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
38+
2. Clone this repository.
39+
3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
40+
4. Select the `containers/plantuml` folder.
41+
5. After the folder has opened in the container, open `sample.plantuml` in the `test-project` folder and hit <kbd>Alt</kbd>+<kbd>d</kbd> to see the illustration.
42+
6. Next, open `markdownsample.md` and see the embedded UML diagram.
2243

2344
## License
2445

0 commit comments

Comments
 (0)