3.5 KiB
[Name of Definition Here] (Community)
Summary
[A short description of the the purpose of the definition goes here.]
| Metadata | Value |
|---|---|
| Contributors | [Your name, GitHub profile] |
| Categories | Community, [Languages, Frameworks, Services, Azure, GCP, AWS, GitHub, Other] |
| Definition type | Dockerfile |
| Works in Codespaces | Yes / No |
| Container host OS support | Linux, macOS, Windows |
| Container OS | [OS used by continer - e.g. Debian] |
| Languages, platforms | [Languages and platforms the container supports] |
[Optional] Description
[Give a more detailed description of the container if the summary does not provide enough info.]
Using this definition
[Optional] Include any special setup requirements here. For example:
While the definition itself works unmodified, you can select the version of YOUR RUNTIME HERE the container uses by updating the VARIANT arg in the included .devcontainer/devcontainer.json file.
"args": { "VARIANT": "buster" }
Adding the definition to a project or codespace
-
If this is your first time using a development container, please see getting started information on setting up Remote-Containers or creating a codespace using GitHub Codespaces.
-
Start VS Code and open your project folder or connect to a codespace.
-
Press F1 select and Add Development Container Configuration Files... command for Remote-Containers or Codespaces.
Note: If needed, you can drag-and-drop the
.devcontainerfolder from this sub-folder in a locally cloned copy of this repository into the VS Code file explorer instead of using the command. -
Select this definition. You may also need to select Show All Definitions... for it to appear.
-
Finally, press F1 and run Remote-Containers: Reopen Folder in Container or Codespaces: Rebuild Container to start using the definition.
[Optional] Testing the definition
This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps:
- If this is your first time using a development container, please follow the getting started steps to set up your machine.
- Clone this repository.
- Start VS Code, press F1, and select Remote-Containers: Open Folder in Container...
- Select this folder from the cloned repository.
- [Provide any information on steps required to test the definition.]
[Optional] How it works
[If the definition provides a pattern you think will be useful for others, describe the it here.]
License
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See LICENSE.