Skip to content

Commit 5f8324e

Browse files
committed
Addition of instructions for a beginner
1 parent 132ad73 commit 5f8324e

File tree

1 file changed

+30
-23
lines changed

1 file changed

+30
-23
lines changed

Diff for: .devcontainer/README.md

+30-23
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,45 @@
1-
Using DevContainers in Visual Studio Code: Quick step by step Start Guide
1+
# Using DevContainers in Visual Studio Code: Quick Start Guide
22

3-
Step 1: Install Visual Studio Code
4-
Download and install Visual Studio Code from the official website: Visual Studio Code.
3+
## Step 1: Install Visual Studio Code
54

6-
Step 2: Install Docker
7-
Ensure Docker is installed on your machine. You can download it from the official Docker website: Docker.
5+
Download and install **Visual Studio Code** from the [official website](https://code.visualstudio.com/).
86

9-
Step 3: Open a Project in Visual Studio Code
10-
Open the project you want to work on in Visual Studio Code.
7+
## Step 2: Install Docker
118

12-
Step 4: Install the Remote Development Extension Pack
13-
Install the "Remote Development" extension pack in Visual Studio Code. This pack includes extensions that enable you to work with development environments in containers, WSL, or SSH. You can find the extension pack here.
9+
Ensure **Docker** is installed on your machine. You can download it from the [official Docker website](https://docs.docker.com/get-docker/).
1410

15-
Step 5: Open the Command Palette
16-
Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS) to open the Command Palette.
11+
## Step 3: Open a Project in Visual Studio Code
1712

18-
Step 6: Choose a DevContainer Configuration
19-
Type and select "Remote-Containers: Add Development Container Configuration Files" from the Command Palette. Choose a predefined configuration (e.g., Node.js, Python, etc.) or select "Other" to create a custom configuration.
13+
Open the project you want to work on in **Visual Studio Code**.
2014

21-
Step 7: Customize the DevContainer Configuration (Optional)
22-
If you selected "Other," customize the devcontainer.json file according to your project's needs, specifying the required tools, extensions, and settings for the DevContainer.
15+
## Step 4: Install the Remote Development Extension Pack
2316

24-
Step 8: Reopen the Project in a DevContainer
25-
Open the Command Palette again and select "Remote-Containers: Reopen in Container." Visual Studio Code will build the Docker image, set up the DevContainer, and reopen your project within the container.
17+
Install the **Remote Development** extension pack in **Visual Studio Code**. This pack includes extensions that enable you to work with development environments in containers, WSL, or SSH. You can find the extension pack [here](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack).
2618

27-
Step 9: Work in the DevContainer
28-
You are now working within the DevContainer. Make your changes, write code, and use the integrated tools and extensions.
19+
## Step 5: Open the Command Palette
2920

30-
Step 10: Save and Commit Your Work
31-
Save your changes within the DevContainer. All changes are saved to your local workspace and are persistent across container restarts.
21+
Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (macOS) to open the **Command Palette**.
3222

33-
Step 11: Stop or Restart the DevContainer
34-
To stop the DevContainer, click on the bottom-left corner where it says "DevContainer" and choose "Stop Container." To restart, use "Reopen in Container" again.
23+
## Step 6: Choose a DevContainer Configuration
3524

25+
Type and select **"Remote-Containers: Add Development Container Configuration Files"** from the **Command Palette**. Choose a predefined configuration (e.g., Node.js, Python, etc.) or select **"Other"** to create a custom configuration.
3626

27+
## Step 7: Customize the DevContainer Configuration (Optional)
3728

29+
If you selected **"Other,"** customize the `devcontainer.json` file according to your project's needs, specifying the required tools, extensions, and settings for the DevContainer.
3830

31+
## Step 8: Reopen the Project in a DevContainer
32+
33+
Open the **Command Palette** again and select **"Remote-Containers: Reopen in Container."** Visual Studio Code will build the Docker image, set up the DevContainer, and reopen your project within the container.
34+
35+
## Step 9: Work in the DevContainer
36+
37+
You are now working within the **DevContainer.** Make your changes, write code, and use the integrated tools and extensions.
38+
39+
## Step 10: Save and Commit Your Work
40+
41+
Save your changes within the **DevContainer.** All changes are saved to your local workspace and are persistent across container restarts.
42+
43+
## Step 11: Stop or Restart the DevContainer
44+
45+
To stop the **DevContainer,** click on the bottom-left corner where it says **"DevContainer"** and choose **"Stop Container."** To restart, use **"Reopen in Container"** again.

0 commit comments

Comments
 (0)