Skip to content

Commit

Permalink
Add docs to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
martineckardt committed Mar 5, 2024
1 parent ebdec01 commit 97fa3dd
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 97fa3dd

Please sign in to comment.