Skip to content

Commit

Permalink
chore: update DEVREADME
Browse files Browse the repository at this point in the history
Signed-off-by: Jason C. Leach <[email protected]>
  • Loading branch information
jleach committed Feb 15, 2023
1 parent d084caf commit f3da910
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.env
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
# go in here.
#
# Example(s)
# GENESIS_TXN_PATH=network/genesis/local-genesis.txn
# GENESIS_TXN_PATH=/work/network/genesis/local-genesis.txn
#
10 changes: 9 additions & 1 deletion DEVREADME.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@ This file is intended for developers working on the internals of the framework.

## VSCode devContainer

This project comes with a [.devcontainer](./devcontainer) to make it as easy as possible to setup your dev environment and begin contributing to this project. All the [environment variables](https://code.visualstudio.com/remote/advancedcontainers/environment-variables) noted below can be added to [devcontainer.env](./devcontainer.env) and exposed to the development docker container.
This project comes with a [.devcontainer](./devcontainer) to make it as easy as possible to setup your dev environment and begin contributing to this project.

All the [environment variables](https://code.visualstudio.com/remote/advancedcontainers/environment-variables) noted below can be added to [devcontainer.env](./devcontainer.env) and exposed to the development docker container.

When running in a container your project root directory will be `/work`. Use this to correctly path any environment variables, for example:

```console
GENESIS_TXN_PATH=/work/network/genesis/local-genesis.txn
```

## Running tests

Expand Down

0 comments on commit f3da910

Please sign in to comment.