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

Commit b10d3f6

Browse files
committed
README corrections
1 parent f9863a7 commit b10d3f6

File tree

8 files changed

+48
-17
lines changed

8 files changed

+48
-17
lines changed

containers/cpp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This definition does require any special steps to use. Just follow these steps:
1919
2. To use VS Code's copy of this definition:
2020
1. Start VS Code and open your project folder.
2121
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22-
3. Select the Dart definition.
22+
3. Select the C++ definition.
2323

2424
3. To use latest-and-greatest copy of this definition from the repository:
2525
1. Clone this repository.

containers/dart/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ This definition includes some test code that will help you verify it is working
3838
2. Clone this repository.
3939
3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
4040
4. Select the `containers/dart` folder.
41-
5. After the folder has opened in the container, press <kbd>F5</kbd> to start the project. This will automatically run `pub get` and build the code be for starting it.
41+
5. After the folder has opened in the container, press <kbd>F5</kbd> to start the project. This will automatically run `pub get` and build the code before starting it.
4242
6. Once the project is running, press <kbd>F1</kbd> and select **Remote-Containers: Forward Port...**
43-
7. Select port 8080 and open `http://localhost:8080` in a browser.
43+
7. Select port 8080 and click the "Open Browser" button in the notification that appears.
4444
8. You should see "Hello remote world!" after the page loads.
4545
9. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing.
4646

containers/dotnetcore-2.1-fsharp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Beyond that, just follow these steps to use the definition:
2525
2. To use VS Code's copy of this definition:
2626
1. Start VS Code and open your project folder.
2727
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
28-
3. Select the Dart definition.
28+
3. Select the F# (.NET Core 2.1) definition.
2929

3030
3. To use latest-and-greatest copy of this definition from the repository:
3131
1. Clone this repository.

containers/dotnetcore-2.1/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Beyond that, just follow these steps to use the definition:
2525
2. To use VS Code's copy of this definition:
2626
1. Start VS Code and open your project folder.
2727
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
28-
3. Select the Dart definition.
28+
3. Select the C# (.NET Core 2.1) definition.
2929

3030
3. To use latest-and-greatest copy of this definition from the repository:
3131
1. Clone this repository.
@@ -47,7 +47,7 @@ This definition includes some test code that will help you verify it is working
4747
5. After the folder has opened in the container, if prompted to restore packages in a notification, click "Restore".
4848
6. After packages are restored, press <kbd>F5</kbd> to start the project.
4949
7. Once the project is running, press <kbd>F1</kbd> and select **Remote-Containers: Forward Port...**
50-
8. Select port 8090 and open `http://localhost:8090` in a browser.
50+
8. Select port 8090 and click the "Open Browser" button in the notification that appears.
5151
9. You should see "Hello remote world from ASP.NET Core!" after the page loads.
5252
10. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing.
5353

containers/dotnetcore-latest-fsharp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Beyond that, just follow these steps to use the definition:
2525
2. To use VS Code's copy of this definition:
2626
1. Start VS Code and open your project folder.
2727
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
28-
3. Select the Dart definition.
28+
3. Select the F# (.NET Core Latest) definition.
2929

3030
3. To use latest-and-greatest copy of this definition from the repository:
3131
1. Clone this repository.

containers/dotnetcore-latest/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Beyond that, just follow these steps to use the definition:
2525
2. To use VS Code's copy of this definition:
2626
1. Start VS Code and open your project folder.
2727
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
28-
3. Select the Dart definition.
28+
3. Select the C# (.NET Core Latest) definition.
2929

3030
3. To use latest-and-greatest copy of this definition from the repository:
3131
1. Clone this repository.
@@ -47,7 +47,7 @@ This definition includes some test code that will help you verify it is working
4747
5. After the folder has opened in the container, if prompted to restore packages in a notification, click "Restore".
4848
6. After packages are restored, press <kbd>F5</kbd> to start the project.
4949
7. Once the project is running, press <kbd>F1</kbd> and select **Remote-Containers: Forward Port...**
50-
8. Select port 8090 and open `http://localhost:8090` in a browser.
50+
8. Select port 8090 and click the "Open Browser" button in the notification that appears.
5151
9. You should see "Hello remote world from ASP.NET Core!" after the page loads.
5252
10. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing.
5353

containers/go/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This definition does require any special steps to use. Just follow these steps:
1919
2. To use VS Code's copy of this definition:
2020
1. Start VS Code and open your project folder.
2121
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22-
3. Select the Dart definition.
22+
3. Select the Go definition.
2323

2424
3. To use latest-and-greatest copy of this definition from the repository:
2525
1. Clone this repository.
@@ -38,8 +38,9 @@ This definition includes some test code that will help you verify it is working
3838
2. Clone this repository.
3939
3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
4040
4. Select the `containers/go` folder.
41-
5. After the folder has opened in the container, press <kbd>F5</kbd> to start the project. You should see "Hello remote world!" in the debug console.
42-
6. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing.
41+
5. After the folder has opened in the container, press <kbd>F5</kbd> to start the project.
42+
6. You should see "Hello remote world!" in the Debug Console after the program executes.
43+
7. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing.
4344

4445
## License
4546

containers/java-8-maven/README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,45 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | Java, Maven |
1212

13-
## Usage
13+
## Using this definition with an existing folder
14+
When using this development container, it's important to note that only the integrated terminal is currently supported in Dev Containers. You may need to modify `launch.json` configurations to include the following value if an external console is used.
1415

15-
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).
16+
```json
17+
"console": "integratedTerminal"
18+
```
1619

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
18-
If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.
20+
Beyond that, just follow these steps to use the definition:
21+
22+
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.
23+
24+
2. To use VS Code's copy of this definition:
25+
1. Start VS Code and open your project folder.
26+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
27+
3. Select the Java 8 & Maven definition.
28+
29+
3. To use latest-and-greatest copy of this definition from the repository:
30+
1. Clone this repository.
31+
2. Copy the contents of `containers/java-8-maven/.devcontainer` to the root of your project folder.
32+
3. Start VS Code and open your project folder.
33+
34+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
35+
36+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
37+
38+
## Testing the definition
39+
40+
This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps:
41+
42+
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.
43+
2. Clone this repository.
44+
3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
45+
4. Select the `containers/java-8-maven` folder.
46+
5. After the folder has opened in the container, press <kbd>F5</kbd> to start the project.
47+
6. You should see "Hello Remote World!" in the a Debug Console after the program executes.
48+
7. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing.
1949

2050
## License
2151

2252
Copyright (c) Microsoft Corporation. All rights reserved.
2353

24-
Licensed under the MIT License. See [LICENSE](../../LICENSE).
54+
Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).

0 commit comments

Comments
 (0)