diff --git a/container-templates/docker-compose/README.md b/container-templates/docker-compose/README.md index 543702a99d..c9a8428a76 100644 --- a/container-templates/docker-compose/README.md +++ b/container-templates/docker-compose/README.md @@ -10,21 +10,48 @@ | *Definition type* | Docker Compose | | *Languages, platforms* | [Languages and platforms the container supports] | -## Description +## [Optional] Description -[Give a more detailed description of the container if the summary does not provide enough info.] +**[Give a more detailed description of the container if the summary does not provide enough info.]** -## Usage +## Using this definition with an existing folder -[Optional - Provide any information on steps required to use the definition.] +**[Optional] Include any special setup requirements here.** -## How it works +Just follow these steps: -[Optional - If the definition provides a pattern you think will be useful for others, describe the pattern here.] +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. + +2. To use VS Code's copy of this definition: + 1. Start VS Code and open your project folder. + 2. Press F1 select and **Remote-Containers: Create Container Configuration File...** from the command palette. + 3. Select the Dart definition. + +3. To use latest-and-greatest copy of this definition from the repository: + 1. Clone this repository. + 2. Copy the contents of this folder in the cloned repository to the root of your project folder. + 3. Start VS Code and open your project folder. + +4. After following step 2 or 3, you can modify the contents of the `.devcontainer` directory added to your project folder to meet your needs. + +5. Finally, press F1 and run **Remote-Containers: Reopen Folder in Container** to start using the definition. + +## [Optional] Testing the definition + +This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps: + +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. +2. Clone this repository. +3. Start VS Code, press F1, and select **Remote-Containers: Open Folder in Container...** +4. Select this folder from the cloned repository. +5. **[Provide any information on steps required to test the definition.]** + +## [Optional] How it works + +**[If the definition provides a pattern you think will be useful for others, describe the it here.]** ## License Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). - +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/LICENSE). \ No newline at end of file diff --git a/container-templates/dockerfile/README.md b/container-templates/dockerfile/README.md index 8d73c804f7..e464885dc7 100644 --- a/container-templates/dockerfile/README.md +++ b/container-templates/dockerfile/README.md @@ -10,20 +10,48 @@ | *Definition type* | Dockerfile | | *Languages, platforms* | [Languages and platforms the container supports] | -## Description +## [Optional] Description -[Give a more detailed description of the container if the summary does not provide enough info.] +**[Give a more detailed description of the container if the summary does not provide enough info.]** -## Usage +## Using this definition with an existing folder -[Optional - Provide any information on steps required to use the definition.] +**[Optional] Include any special setup requirements here.** -## How it works +Just follow these steps: -[Optional - If the definition provides a pattern you think will be useful for others, describe the pattern here.] +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. + +2. To use VS Code's copy of this definition: + 1. Start VS Code and open your project folder. + 2. Press F1 select and **Remote-Containers: Create Container Configuration File...** from the command palette. + 3. Select the Dart definition. + +3. To use latest-and-greatest copy of this definition from the repository: + 1. Clone this repository. + 2. Copy the contents of this folder in the cloned repository to the root of your project folder. + 3. Start VS Code and open your project folder. + +4. After following step 2 or 3, you can modify the contents of the `.devcontainer` directory added to your project folder to meet your needs. + +5. Finally, press F1 and run **Remote-Containers: Reopen Folder in Container** to start using the definition. + +## [Optional] Testing the definition + +This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps: + +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. +2. Clone this repository. +3. Start VS Code, press F1, and select **Remote-Containers: Open Folder in Container...** +4. Select this folder from the cloned repository. +5. **[Provide any information on steps required to test the definition.]** + +## [Optional] How it works + +**[If the definition provides a pattern you think will be useful for others, describe the it here.]** ## License Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/LICENSE). \ No newline at end of file diff --git a/container-templates/image/README.md b/container-templates/image/README.md index 9dd56be37b..5237a74389 100644 --- a/container-templates/image/README.md +++ b/container-templates/image/README.md @@ -10,20 +10,48 @@ | *Definition type* | Image | | *Languages, platforms* | [Languages and platforms the container supports] | -## Description +## [Optional] Description -[Give a more detailed description of the container if the summary does not provide enough info.] +**[Give a more detailed description of the container if the summary does not provide enough info.]** -## Usage +## Using this definition with an existing folder -[Optional - Provide any information on steps required to use the definition.] +**[Optional] Include any special setup requirements here.** -## How it works +Just follow these steps: -[Optional - If the definition provides a pattern you think will be useful for others, describe the pattern here.] +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. + +2. To use VS Code's copy of this definition: + 1. Start VS Code and open your project folder. + 2. Press F1 select and **Remote-Containers: Create Container Configuration File...** from the command palette. + 3. Select the Dart definition. + +3. To use latest-and-greatest copy of this definition from the repository: + 1. Clone this repository. + 2. Copy the contents of this folder in the cloned repository to the root of your project folder. + 3. Start VS Code and open your project folder. + +4. After following step 2 or 3, you can modify the contents of the `.devcontainer` directory added to your project folder to meet your needs. + +5. Finally, press F1 and run **Remote-Containers: Reopen Folder in Container** to start using the definition. + +## [Optional] Testing the definition + +This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps: + +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. +2. Clone this repository. +3. Start VS Code, press F1, and select **Remote-Containers: Open Folder in Container...** +4. Select this folder from the cloned repository. +5. **[Provide any information on steps required to test the definition.]** + +## [Optional] How it works + +**[If the definition provides a pattern you think will be useful for others, describe the it here.]** ## License Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/LICENSE). \ No newline at end of file diff --git a/containers/dart/README.md b/containers/dart/README.md index d9af5ad337..83789f0071 100644 --- a/containers/dart/README.md +++ b/containers/dart/README.md @@ -10,9 +10,9 @@ | *Definition type* | Dockerfile | | *Languages, platforms* | Dart | -## Using the definition with an existing folder +## Using this definition with an existing folder -This definition does not have any special setup requirements, so follow these steps to use it: +This definition does require any special steps to use. Just follow these steps: 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. @@ -26,12 +26,13 @@ This definition does not have any special setup requirements, so follow these st 2. Copy the contents of `containers/dart/.devcontainer` to the root of your project folder. 3. Start VS Code and open your project folder. -4. Modify the contents of the `.devcontainer` folder added to your project as needed. -5. Press F1 and run **Remote-Containers: Reopen Folder in Container** to use it. +4. After following step 2 or 3, you can modify the contents of the `.devcontainer` directory added to your project folder to meet your needs. + +5. Finally, press F1 and run **Remote-Containers: Reopen Folder in Container** to start using the definition. ## Testing the definition -This definition includes some test code that you can use to verify it is working as expected on your system. Follow these steps: +This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps: 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. 2. Clone this repository. @@ -39,11 +40,11 @@ This definition includes some test code that you can use to verify it is working 4. Select the `containers/dart` folder. 5. After the folder has opened in the container, press F5 to start the project. This will automatically run `pub get` and build the code be for starting it. 6. Once the project is running, press F1 and select **Remote-Containers: Forward Port...** -7. Select port 8080 and open `http://localhost:8080` in a browser. -8. From here, you can add breakpoints or edit the contents of the `test-project` folder for further testing. +7. Select port 8080 and open `http://localhost:8080` in a browser. You should see "Hello remote world!" +8. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing. ## License Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/LICENSE). \ No newline at end of file diff --git a/containers/go/.devcontainer/Dockerfile b/containers/go/.devcontainer/Dockerfile index c5cda56148..e078b0898f 100644 --- a/containers/go/.devcontainer/Dockerfile +++ b/containers/go/.devcontainer/Dockerfile @@ -21,7 +21,7 @@ RUN go get -u -v \ honnef.co/go/tools/... \ github.com/golangci/golangci-lint/cmd/golangci-lint \ github.com/mgechev/revive \ - github.com/derekparker/delve/cmd/dlv + github.com/derekparker/delve/cmd/dlv 2>&1 # gocode-gomod RUN go get -x -d github.com/stamblerre/gocode \ diff --git a/containers/go/.vscode/launch.json b/containers/go/.vscode/launch.json index 164eb253a7..beb3676a70 100644 --- a/containers/go/.vscode/launch.json +++ b/containers/go/.vscode/launch.json @@ -2,11 +2,11 @@ "version": "0.2.0", "configurations": [ { - "name": "Launch file", + "name": "Launch", "type": "go", "request": "launch", "mode": "debug", - "program": "${file}" + "program": "${workspaceFolder}/test-project/hello.go" } ] } \ No newline at end of file diff --git a/containers/go/README.md b/containers/go/README.md index 3d8d209bef..1605a409af 100644 --- a/containers/go/README.md +++ b/containers/go/README.md @@ -10,16 +10,39 @@ | *Definition type* | Dockerfile | | *Languages, platforms* | Go | -## Usage +## Using this definition with an existing folder -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +This definition does require any special steps to use. Just follow these steps: -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. +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. -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. +2. To use VS Code's copy of this definition: + 1. Start VS Code and open your project folder. + 2. Press F1 select and **Remote-Containers: Create Container Configuration File...** from the command palette. + 3. Select the Dart definition. + +3. To use latest-and-greatest copy of this definition from the repository: + 1. Clone this repository. + 2. Copy the contents of `containers/go/.devcontainer` to the root of your project folder. + 3. Start VS Code and open your project folder. + +4. After following step 2 or 3, you can modify the contents of the `.devcontainer` directory added to your project folder to meet your needs. + +5. Finally, press F1 and run **Remote-Containers: Reopen Folder in Container** to start using the definition. + +## Testing the definition + +This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps: + +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. +2. Clone this repository. +3. Start VS Code, press F1, and select **Remote-Containers: Open Folder in Container...** +4. Select the `containers/go` folder. +5. After the folder has opened in the container, press F5 to start the project. You should see "Hello remote world!" in the debug console. +6. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing. ## License Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/LICENSE). \ No newline at end of file diff --git a/containers/go/test-project/hello.go b/containers/go/test-project/hello.go index 68bf00b1ee..ffc1a3ac7a 100644 --- a/containers/go/test-project/hello.go +++ b/containers/go/test-project/hello.go @@ -6,5 +6,5 @@ package main import "fmt" func main() { - fmt.Println("hello world") + fmt.Println("Hello remote world!") } \ No newline at end of file