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

Commit

Permalink
Update Go, README edits
Browse files Browse the repository at this point in the history
  • Loading branch information
Chuxel committed Apr 22, 2019
1 parent aef0e34 commit c434d36
Show file tree
Hide file tree
Showing 8 changed files with 146 additions and 39 deletions.
43 changes: 35 additions & 8 deletions container-templates/docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <kbd>F1</kbd> 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 <kbd>F1</kbd> 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 <kbd>F1</kbd>, 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).
42 changes: 35 additions & 7 deletions container-templates/dockerfile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <kbd>F1</kbd> 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 <kbd>F1</kbd> 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 <kbd>F1</kbd>, 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).
42 changes: 35 additions & 7 deletions container-templates/image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <kbd>F1</kbd> 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 <kbd>F1</kbd> 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 <kbd>F1</kbd>, 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).
17 changes: 9 additions & 8 deletions containers/dart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -26,24 +26,25 @@ 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 <kbd>F1</kbd> 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 <kbd>F1</kbd> 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.
3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
4. Select the `containers/dart` folder.
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.
6. Once the project is running, press <kbd>F1</kbd> 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).
2 changes: 1 addition & 1 deletion containers/go/.devcontainer/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
4 changes: 2 additions & 2 deletions containers/go/.vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
}
33 changes: 28 additions & 5 deletions containers/go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <kbd>F1</kbd> 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 <kbd>F1</kbd> 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 <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
4. Select the `containers/go` folder.
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.
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).
2 changes: 1 addition & 1 deletion containers/go/test-project/hello.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@
package main
import "fmt"
func main() {
fmt.Println("hello world")
fmt.Println("Hello remote world!")
}

0 comments on commit c434d36

Please sign in to comment.