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

Commit

Permalink
More README edits
Browse files Browse the repository at this point in the history
  • Loading branch information
Chuxel committed Apr 4, 2019
1 parent 4562f81 commit 50c15fb
Show file tree
Hide file tree
Showing 29 changed files with 91 additions and 191 deletions.
11 changes: 3 additions & 8 deletions containers/azure-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,11 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:
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.

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

If you want to try out the test project instead, run **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.
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.

## License

Expand Down
9 changes: 2 additions & 7 deletions containers/azure-functions-node-8/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

## License

Expand Down
9 changes: 2 additions & 7 deletions containers/azure-hdinsight-python-3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

## License

Expand Down
9 changes: 2 additions & 7 deletions containers/azure-machine-learning-python-3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

## License

Expand Down
9 changes: 2 additions & 7 deletions containers/azure-terraform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

## License

Expand Down
9 changes: 2 additions & 7 deletions containers/cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

Expand Down
9 changes: 2 additions & 7 deletions containers/dart-web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

Expand Down
7 changes: 3 additions & 4 deletions containers/docker-existing-docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,15 @@
## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with an existing project that contains a `docker-compose.yml` file:

1. Copy the `.devcontainer` folder into your project root.
2. Modify the `.devcontainer/dev-container.yml` and `devcontainer.json` files as needed (see comments)
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.
3. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
[See here for more information on using this definition with an existing project](../../README.md#using-a-definition).

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.
## License

Copyright (c) Microsoft Corporation. All rights reserved.
Expand Down
6 changes: 3 additions & 3 deletions containers/docker-existing-dockerfile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@
| *Languages, platforms* | Any |

> **Note:** There is also a [Docker Compose](../docker-existing-docker-compose) variation of this same definition.
>
## Usage
First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
## Usage

To use the definition with your own project that contains a `Dockerfile`:

1. Copy the `.devcontainer` folder into your project root.
2. Modify the `.devcontainer/devcontainer.json` as needed (see comments)
3. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

[See here for more information on using this definition with an existing project](../../README.md#using-a-definition).

## License

Copyright (c) Microsoft Corporation. All rights reserved.
Expand Down
7 changes: 2 additions & 5 deletions containers/docker-in-docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,9 @@ Dev containers can be useful for all types of applications including those that

## Usage

To use the definition with an existing project:
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

No additional setup steps are required, but note that the included `.devcontainer/Dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example:

Expand Down
9 changes: 2 additions & 7 deletions containers/docker-in-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,9 @@ Dev containers can be useful for all types of applications including those that

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with an existing project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

No additional setup steps are required, but note that the included `.devcontainer/Dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example:

Expand Down
9 changes: 2 additions & 7 deletions containers/dotnetcore-2.2-fsharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

Expand Down
9 changes: 2 additions & 7 deletions containers/dotnetcore-2.2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

Expand Down
9 changes: 2 additions & 7 deletions containers/go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

Expand Down
10 changes: 2 additions & 8 deletions containers/java-8-maven/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

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.
If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

## License
Expand Down
9 changes: 2 additions & 7 deletions containers/javascript-node-8-mongo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

Expand Down
9 changes: 2 additions & 7 deletions containers/javascript-node-8/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

Expand Down
11 changes: 2 additions & 9 deletions containers/markdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.
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.

## License

Expand Down
9 changes: 2 additions & 7 deletions containers/php-7/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
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.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

Expand Down
Loading

0 comments on commit 50c15fb

Please sign in to comment.