From 8bdb1381555b64f5d664ca70005b9d6d266008d2 Mon Sep 17 00:00:00 2001 From: Kegan Maher Date: Wed, 11 Dec 2024 00:01:22 +0000 Subject: [PATCH] docs: getting started - vscode prereq --- docs/development/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/docs/development/README.md b/docs/development/README.md index cae0b74..6033bf6 100644 --- a/docs/development/README.md +++ b/docs/development/README.md @@ -76,3 +76,34 @@ brew services start colima Docker CE (also known as Docker Engine) is how to run Docker and Compose on Linux. Docker provides an [installation guide for Docker CE](https://docs.docker.com/engine/install/). + +### VS Code and Dev Containers extension + +VS Code is an open source Integrated Development Environment (IDE) from Microsoft. Check if you already have it installed: + +```shell +code -v +``` + +If installed, output should look similar to: + +```console +$ code -v +1.95.3 +f1a4fb101478ce6ec82fe9627c43efbf9e98c813 +x64 +``` + +Otherwise, [download VS Code](https://code.visualstudio.com/download) for your operating system. + +Once installed, open VS Code and enter `Ctrl`/`Cmd` + `P` to open the VS Code Quick Open pane. Then enter: + +```console +ext install ms-vscode-remote.remote-containers +``` + +`ms-vscode-remote.remote-containers` is the Extension ID of the +[Dev Containers extension from Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). + +For more about why we use Dev Containers, check our Compiler's blog post: +[_How to support a platform-agnostic engineering team with VS Code Dev Containers_](https://compiler.la/blog/2024/devcontainer-platform-agnostic-team).