From 97fa3ddf60ba90da94d0a7f60e6bb756ec07307b Mon Sep 17 00:00:00 2001 From: Martin Eckardt Date: Tue, 5 Mar 2024 16:47:07 +0100 Subject: [PATCH] Add docs to Readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 8e7fee9b..4d866f59 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,10 @@ export PATH=~/bin:$PATH To add it to your path permanently, add an export command to your shell initialization script (ex: .bashrc). +## Dev Container & Codespace + +To get started easily, we provide a Dev Container specification, that can be used using GitHub Codespace or locally using Docker and VS Code. [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) are a concept that utilizes containerization to create consistent and isolated development environment. You can run them directly on Github by clicking **Code**, switching to the **Codespaces** tab and clicking **Create codespace on main**. Alternatively, you can run them locally with the extensions for [VS Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) or other code editors. + ## Build from source code This is only needed by advanced users who want to modify or test Avalanche Network Runner in specific ways.