From a2ce2d005813e30e56f5c671d2bb590102f3678f Mon Sep 17 00:00:00 2001 From: Greg Van Liew Date: Thu, 25 Apr 2019 17:44:46 -0700 Subject: [PATCH] Update README --- README.md | 45 +++++++++++++++++++++------------------------ 1 file changed, 21 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 7fecb8c55e..bd5c536f34 100644 --- a/README.md +++ b/README.md @@ -9,44 +9,44 @@ -A **development container** is a running container with a well defined tool and runtime stack and their prerequisites. The Remote - Containers extension in the [Remote Development](https://aka.ms/vscode-remote/download/extension) extension pack allows you to open any folder inside (or mounted into) a dev container and take advantage of VS Code's full feature set. +A **development container** is a running [Docker](https://www.docker.com) container with a well-defined tool/runtime stack and its prerequisites. The Remote - Containers extension in the [Remote Development](https://aka.ms/vscode-remote/download/extension) extension pack allows you to open any folder inside (or mounted into) a dev container and take advantage of VS Code's full development feature set. -This repository contains a set of **dev container definitions** to help get you up and running in a containerized environment. They describe the needed container image, any runtime arguments for starting the container, and any VS Code extensions that should be installed into it. They're can help you get started or be used as examples for adapting your own configuration to different situations. +This repository contains a set of **dev container definitions** to help get you up and running with a containerized environment. The definitions describe the appropriate container image, runtime arguments for starting the container, and VS Code extensions that should be installed. They can help you get started or be used as examples for adapting your own configuration to different situations. ## Using a definition To add a dev container definition in your project, you can either: -- Add them using VS Code: +- Add it using VS Code: 1. If this is your first time creating a dev container, follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to configure your machine. 2. Start VS Code and open your project folder. 3. Press F1 - and select either the **Remote-Containers: Create Container Configuration File...** or **Remote-Containers: Reopen Folder in Container** commands. - 4. Follow the directions and pick a development container definition when the list appears. + and select either the **Remote-Containers: Create Container Configuration File...** or **Remote-Containers: Reopen Folder in Container** commands. + 4. Follow the directions and pick one of the existing development container definitions in this repository from the list. -- Or manually copy the contents of one of folders in the `containers` directory into your project. Typically you can just copy the `.devcontainer` folder ignore everything else. See the definition's `README` for details. +- Or manually copy the contents of one of folders in the `containers` directory into your project. You should be able to copy just the `.devcontainer` folder and ignore everything else. See the definition's `README` for details. -## Adding a definition to an existing public or private repo +## Adding a definition to an existing repository -You can easily share a customized dev container definition for your project by simply adding files like `.devcontainer/devcontainer.json` to source control. By including these files in your repository, anyone that opens a local copy of your repo in VS Code will be automatically asked if they want reopen the folder in a container instead if the [Remote Development](https://aka.ms/vscode-remote/download/extension) extension pack is installed. +You can share a customized dev container definition for your project by adding the files under `.devcontainer` to source control. Anyone who then opens a local copy of your repo in VS Code will be prompted to reopen the folder in a container, provided they have the [Remote Development](https://aka.ms/vscode-remote/download/extension) extension pack installed. -Beyond the advantages of having your team use a consistent environment and tool-chain, doing this can make it easier for new contributors or team members to get productive quickly. First-time contributors will require less guidance and are less likely to either submit issues or contribute code with issues that are related to environment setup. +Your team now has a consistent environment and tool-chain and new contributors or team members can be productive quickly. First-time contributors will require less guidance and there will be fewer issues related to environment setup. ## Testing a definition If you want to test a definition before choosing one: 1. If this is your first time creating a dev container, follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to configure your machine. -2. Browse the contents of the `containers` folder in this repository and pick one. Check out the `README` to see if there are any manual setup steps you should be aware of before continuing. +2. Browse the contents of the `containers` folder in this repository and pick one. Review the `README` to see if there are any manual setup steps before continuing. 3. Clone this repository locally. 4. Start VS Code, press F1, and run the **Remote-Containers: Open Folder in Container...** command. 5. Select the root of the definition folder from the cloned repository when prompted (**not** the `test-project` folder if present). 6. See the definition's `README` for what to do next. -## Sample Projects +## Sample projects -If you're looking to try a sample project rather than information on setting up a dev container, check out one of the following repositories: +If you want to try a sample project which already has a dev container, check out one of the following repositories: - [Node Sample](https://github.com/Microsoft/vscode-remote-try-node) - [Python Sample](https://github.com/Microsoft/vscode-remote-try-python) @@ -58,32 +58,29 @@ If you're looking to try a sample project rather than information on setting up - [Rust Sample](https://github.com/Microsoft/vscode-remote-try-rust) - [.NET Core Sample](https://github.com/Microsoft/vscode-remote-try-dotnetcore) - ## Contents - `containers` - Contains reusable dev container definitions. -- `container-templates` - Contains templates for creating your own container definitions for your project or to [contribute back](CONTRIBUTING.md#contributing-dev-container-definitions). -- `repository-containers` - Dev container definitions for working on a cloned copy of specific, public source code repository (rather than general purpose). +- `container-templates` - Contains templates for creating your own container definitions or to [contribute back](CONTRIBUTING.md#contributing-dev-container-definitions). +- `repository-containers` - Dev container definitions for working public source code repositories. -### Common Questions +## Common Questions -#### Can I just reuse an existing container image or Docker / Docker Compose configuration? +### Can I just reuse an existing container image or Docker / Docker Compose configuration? -Yes! If you want to use an existing Dockerfile as a starting point, run **Remote-Containers: Create Container Configuration File...** from the command pallette (Cmd/Ctrl+Shift+P). You'll be prompted to select a Dockerfile or Docker Compose file and customize from there. If you prefer, you can also you can start up the container any way you see fit and [attach to it](https://aka.ms/vscode-remote/containers/attach) instead. +Yes, if you want to use an existing Dockerfile as a starting point, run **Remote-Containers: Create Container Configuration File...** from the Command Palette (F1). You'll be prompted to select a Dockerfile or Docker Compose file and customize from there. If you prefer, you can also start up the container and [attach to it](https://aka.ms/vscode-remote/containers/attach). -#### What is the goal of `devcontainer.json`? +### What is the goal of `devcontainer.json`? -The intent of `devcontainer.json` is similar to `launch.json` for debugging, but designed to launch (or attach to) a development container instead. At its simplest, all you need to do is add a `.devcontainer/devcontainer.json` file to your project that references an image, `Dockerfile`, or `docker-compose.yml`, and a few properties. You can [adapt it for use](https://aka.ms/vscode-remote/containers/folder-setup) in a wide variety of situations. +A `devcontainer.json` file is similar to `launch.json` for debugging, but designed to launch (or attach to) a development container instead. At its simplest, all you need is a `.devcontainer/devcontainer.json` file in your project that references an image, `Dockerfile`, or `docker-compose.yml`, and a few properties. You can [adapt it for use](https://aka.ms/vscode-remote/containers/folder-setup) in a wide variety of situations. -## Contributing & Feedback +## Contributing and feedback -Have a question or feedback? There are many ways to contribute. +Have a question or feedback? - Contribute or provide feedback for the [VS Code Remote Development extensions](https://github.com/Microsoft/vscode-remote-release/CONTRIBUTING.md). - Search [existing issues](https://github.com/Microsoft/vscode-dev-containers/issues) with dev container definitions or [report a problem](https://github.com/Microsoft/vscode-dev-containers/issues/new). - Contribute a [development container definition](CONTRIBUTING.md#contributing-dev-container-definitions) to the repository. -- Contribute to [our documentation](https://github.com/Microsoft/vscode-docs) or [VS Code itself](https://github.com/Microsoft/vscode). -- ...and more. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or