From 476718e644bcd11f8dbdeaec4fa6eb7a2b0f351b Mon Sep 17 00:00:00 2001 From: Brigit Murtaugh Date: Tue, 29 Mar 2022 10:02:09 -0700 Subject: [PATCH] Add links to open in Remote - Containers (#146073) --- .devcontainer/README.md | 4 ++++ README.md | 1 + 2 files changed, 5 insertions(+) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index f31ebb25e2c..9050664fcee 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -1,11 +1,15 @@ # Code - OSS Development Container +[![Open in Remote - Containers](https://img.shields.io/static/v1?label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) + This repository includes configuration for a development container for working with Code - OSS in a local container or using [GitHub Codespaces](https://github.com/features/codespaces). > **Tip:** The default VNC password is `vscode`. The VNC server runs on port `5901` and a web client is available on port `6080`. ## Quick start - local +If you already have VS Code and Docker installed, you can click the badge above or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) to get started. Clicking these links will cause VS Code to automatically install the Remote - Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use. + 1. Install Docker Desktop or Docker for Linux on your local machine. (See [docs](https://aka.ms/vscode-remote/containers/getting-started) for additional details.) 2. **Important**: Docker needs at least **4 Cores and 8 GB of RAM** to run a full build. If you are on macOS, or are using the old Hyper-V engine for Windows, update these values for Docker Desktop by right-clicking on the Docker status bar item and going to **Preferences/Settings > Resources > Advanced**. diff --git a/README.md b/README.md index 022614a774b..ba8f7224ff7 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,7 @@ VS Code includes a set of built-in extensions located in the [extensions](extens This repository includes a Visual Studio Code Remote - Containers / GitHub Codespaces development container. - For [Remote - Containers](https://aka.ms/vscode-remote/download/containers), use the **Remote-Containers: Clone Repository in Container Volume...** command which creates a Docker volume for better disk I/O on macOS and Windows. + - If you already have VS Code and Docker installed, you can also click [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) to get started. This will cause VS Code to automatically install the Remote - Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use. - For Codespaces, install the [GitHub Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension in VS Code, and use the **Codespaces: Create New Codespace** command. Docker / the Codespace should have at least **4 Cores and 6 GB of RAM (8 GB recommended)** to run full build. See the [development container README](.devcontainer/README.md) for more information.