From 920f4d74d60ab358c10188cd60275836ddfebf72 Mon Sep 17 00:00:00 2001 From: Chuck Lantz Date: Thu, 18 Apr 2019 22:35:50 -0700 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index edf5a01d9f..1f12c517eb 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,34 @@ -# Visual Studio Code Remote Development Container Definitions +# VS Code Remote Development Container Definitions -A **development container** is a running container that comes with a basic tool stack (Python, node, Go, etc.) and its prerequisites (e.g. `pylint` for Python). This container may be used to actually run an application or be focused exclusively on sandboxing tools, libraries, runtimes, or other utilities that need to be run against a codebase.The Containers extension in the [Visual Studio Code 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 container that comes with a basic tool stack (Python, node, Go, etc.) 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 feature set. -This repository contains a set of **dev container definitions** made up of files like `devcontainer.json` to help get you up and running in a containerized environment. These definitions 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 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 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. -**[Learn more!](https://aka.ms/vscode-remote/containers)**. +**[Learn more!](https://aka.ms/vscode-remote/containers)** ## Using a definition -You can either: +To add a dev container definition in your project, you can either: -- Open a folder in VS Code without a `devcontainer.json` file and run the **Remote-Containers: Create Container Configuration File...** or **Remote-Containers: Reopen Folder in Container** commands. You be prompted to pick a definition and any options and the appropriate files will then be added to your project. +- Add them using VS Code: + + 1. Start VS Code and open the your project folder + 2. Press F1 + and select either the **Remote-Containers: Create Container Configuration File...** or **Remote-Containers: Reopen Folder in Container** commands. + 3. Follow the directions and pick a development container definition when the list appears. -- Manually copy the contents of one of the `containers` sub-folders into your project. Typically you can just copy the `.devcontainer` folder into your project but the folder's README may mention additional files. +- Or manually copy the contents of one of the `containers` sub-folders into your project. Typically you can just copy the `.devcontainer` folder into your project and ignore everything else. See the `README` for details. ## Trying a definition -1. Click on one of the `containers` sub-folders to open it in your browser -2. Check out the `README` to see if there are any manual steps -3. Clone this repository or copy the contents of the folder to your machine -4. Run the **Remote-Containers: Open Folder in Container...** command in VS Code -5. Select the root of the definition folder in the "open" dialog (**not** the `test-project` folder if present) +If you want to play with a definition, -Many definitions include a `test-project` with a sample and/or launch settings in the `.vscode` folder that you can use to see the dev container in action. See the `README` for how to use them. +1. Browse the contents of the `containers` in this repository and pick one. Check out the `README` to see if there are any manual steps required before proceeding. +3. Clone this repository or copy the contents of the folder to your machine. +4. Run the **Remote-Containers: Open Folder in Container...** command in VS Code. +5. Select the root of the definition folder in the "open" dialog (**not** the `test-project` folder if present). + +Many definitions include a `test-project` with a sample and/or launch settings in the `.vscode` folder that you can use to see the dev container in action. See the definition's `README` for details. ## Adding a definition to an existing public or private repo