From add354f8a3cbf00aeb17b489534796a583166830 Mon Sep 17 00:00:00 2001 From: Chuck Lantz Date: Fri, 18 Nov 2022 10:33:08 -0600 Subject: [PATCH] Update README.md --- example-usage/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/example-usage/README.md b/example-usage/README.md index 2e265d0a3..08dc5feb2 100644 --- a/example-usage/README.md +++ b/example-usage/README.md @@ -12,7 +12,7 @@ Each should run on macOS or Linux. For Windows, you can use these scripts from W 1. Install Node.js 16 (e.g., using [nvm](https://github.com/nvm-sh/nvm)) 2. Install [node-gyp pre-requisites](https://github.com/nodejs/node-gyp): - - **Linux:** Use your distro's package manager. E.g. on Ubuntu/Debian: `sudo apt-get update && sudo apt-get install python3-minimal gcc g++ make` + - **Linux/WSL2:** Use your distro's package manager. E.g. on Ubuntu/Debian: `sudo apt-get update && sudo apt-get install python3-minimal gcc g++ make` - **macOS:** Install the XCode Command Line Tools ([more info](https://github.com/nodejs/node-gyp/blob/main/README.md#on-macos)) 3. Make sure you have an OpenSSH compliant `ssh` command available and in your path if you plan to use the `Vim via SSH` example (it should already be there on macOS, and in Linux/WSL, you can install `openssh-client` using your distro's package manager if its missing) 3. Install the latest dev container CLI: `npm install -g @devcontainers/cli` @@ -91,4 +91,4 @@ The resulting image name defaults to `devcontainer-cli-test-image`, but you can image-build/build-image.sh ghcr.io/my-org/my-image-name-here true "linux/amd64 linux/arm64" ``` -Ultimately, this script just calls the `devcontainer build` command to do all the work. Once built, you can refer to the specified image name directly in a devcontainer.json file using the `image` property. \ No newline at end of file +Ultimately, this script just calls the `devcontainer build` command to do all the work. Once built, you can refer to the specified image name directly in a devcontainer.json file using the `image` property.