Skip to content
This repository was archived by the owner on Nov 30, 2023. It is now read-only.

Commit 80d894d

Browse files
ChuxelChuxel
committed
README cleanup
1 parent 747b3be commit 80d894d

File tree

7 files changed

+134
-26
lines changed

7 files changed

+134
-26
lines changed

‎containers/azure-cli/README.md‎

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,40 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | Any |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
15+
This definition does require any special steps to use. Just follow these steps:
1616

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
17+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
1818

19-
If you want to try out the test project instead, open a cloned copy of this entire folder **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder and use the content in `test-project` to try things out.
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the Azure CLI definition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/azure-cli/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
32+
33+
## Testing the definition
34+
35+
This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps:
36+
37+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
38+
2. Clone this repository.
39+
3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
40+
4. Select the `containers/azure-cli` folder.
41+
5. After the folder has opened in the container, press <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>`</kbd> to start a new terminal.
42+
6. Open `test-project/scripting.azcli`
43+
7. Right click on one of the lines and select Run Line in Terminal
2044

2145
## License
2246

2347
Copyright (c) Microsoft Corporation. All rights reserved.
2448

25-
Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).
49+
Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).

‎containers/azure-functions-dotnetcore-2.1/README.md‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,27 @@
88
|----------|-------|
99
| *Contributors* | The VS Code Team |
1010
| *Definition type* | Dockerfile |
11-
| *Languages, platforms* | Azure Functions, Node.js, JavaScript |
11+
| *Languages, platforms* | Azure Functions, .NET Core, C# |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
15+
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
1616

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
17+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
18+
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the Azure Functions & C# (.NET Core 2.1) definition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/azure-functions-dotnetcore-2.1/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
1832

1933
## License
2034

‎containers/azure-functions-dotnetcore-latest/README.md‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,33 @@
22

33
## Summary
44

5-
*Develop Azure Functions in C#. Includes NET Core (latest), the Azure Functions SDK, and related extensions and dependencies.*
5+
*Develop Azure Functions in C#. Includes NET Core (Latest), the Azure Functions SDK, and related extensions and dependencies.*
66

77
| Metadata | Value |
88
|----------|-------|
99
| *Contributors* | The VS Code Team |
1010
| *Definition type* | Dockerfile |
11-
| *Languages, platforms* | Azure Functions, Node.js, JavaScript |
11+
| *Languages, platforms* | Azure Functions, .NET Core, C# |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
15+
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
1616

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
17+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
18+
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the Azure Functions & C# (.NET Core Latest) definition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/azure-functions-dotnetcore-latest/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
1832

1933
## License
2034

‎containers/azure-functions-node-lts/README.md‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,25 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | Azure Functions, Node.js, JavaScript |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
15+
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
1616

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
17+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
18+
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the Azure Functions & Node.js (latest LTS) definition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/azure-functions-node-lts/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
1832

1933
## License
2034

‎containers/azure-hdinsight-python-3/README.md‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,25 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | Azure HDInsight, Python |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
15+
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
1616

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
17+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
18+
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the Azure HDInsight sdefinition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/azure-hdinsight-python-3/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
1832

1933
## License
2034

‎containers/azure-machine-learning-python-3/README.md‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,25 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | Azure Machine Learning, Python |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
15+
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
1616

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
17+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
18+
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the Azure Machine Learning definition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/azure-machine-learning-python-3/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
1832

1933
## License
2034

‎containers/azure-terraform/README.md‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,25 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | Terraform |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
15+
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
1616

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
17+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
18+
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the Azure Terraform definition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/azure-terraform/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
1832

1933
## License
2034

0 commit comments

Comments
 (0)