From a9f5c4a6671b5a3dfcd7fe7bfc6fee656d40c416 Mon Sep 17 00:00:00 2001 From: Nick Spaargaren <20847106+nickspaargaren@users.noreply.github.com> Date: Fri, 20 Dec 2024 23:43:22 +0100 Subject: [PATCH] Add devcontainer section to readme (#2275) Co-authored-by: Nick Spaargaren --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index ccad3ec21..a7549f56f 100644 --- a/README.md +++ b/README.md @@ -103,3 +103,20 @@ virtual Python environment with the following command on Linux: If you have verified this command on Windows, we invite you to submit a PR to include that information here. [![Greenkeeper badge](https://badges.greenkeeper.io/writethedocs/www.svg)](https://greenkeeper.io/) + +### Using devcontainer + +In addition to local development with Python `venv`, it is also possible to use the devcontainer found in the root of the project. + +### Requirements + +Make sure all of the following is installed. + +- [Docker](https://docs.docker.com/get-started/get-docker/) +- [Supported IDE](https://containers.dev/supporting#editors) + +Follow the steps below to open the development environment. + +1. Open a [supported IDE](https://containers.dev/supporting#editors) +2. Click the "Open in devcontainer" popup +3. The development environment starts in an containerized environment