Skip to content

Commit a50bf8c

Browse files
committed
Remove setup-dev.md file and keep the relevant part in the main README
Signed-off-by: Guillaume Bourque <[email protected]>
1 parent de7b456 commit a50bf8c

File tree

3 files changed

+12
-68
lines changed

3 files changed

+12
-68
lines changed

README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,19 @@ The described process is automated in one of the ways below (it allow to install
144144
- **Also coming soon:** Create virtual machines in AWS.
145145

146146

147-
148147
## How to Start Working with the Code
149148

150-
Please have a look at [Dev Setup](docs/source/setup-dev.md)
149+
The preferred method of setting up the development environment is to use the **devcontainers**.
150+
All configuration files for VSCode and [Gitpod](https://gitpod.io) are already placed in this repository.
151+
If you are new to the concept of devcontainers in combination with VSCode [here](https://code.visualstudio.com/docs/remote/containers) is a good article about it.
152+
153+
Simply clone this repository and VSCode will most likely ask you to open it in the devcontainer, if you have the correct extension("ms-vscode-remote.remote-containers") installed.
154+
If VSCode didn't ask to open it, open the command palette and use the `Remote-Containers: Rebuild and Reopen in Container` command.
155+
156+
If you want to use Gitpod simply use this [link](https://gitpod.io/#https://github.com/hyperledger/indy-node/tree/main)
157+
or if you want to work with your fork, prefix the entire URL of your branch with `gitpod.io/#` so that it looks like `https://gitpod.io/#https://github.com/hyperledger/indy-node/tree/main`.
158+
159+
**Note**: Be aware that the config files for Gitpod and VSCode are currently only used in the `main` branch!
151160

152161

153162
## Continuous Integration and Delivery

docs/source/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Welcome to Hyperledger Indy Node's documentation!
2222
ci-cd.md
2323
indy-file-structure-guideline.md
2424
write-code-guideline.md
25-
setup-dev.md
25+
2626

2727

2828

docs/source/setup-dev.md

-65
This file was deleted.

0 commit comments

Comments
 (0)