You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-4
Original file line number
Diff line number
Diff line change
@@ -89,8 +89,9 @@ Indy Node repo consists of the following parts:
89
89
- Some scripts that can be run for installed Node (in particular, scripts to start Nodes, generate keys, prepare test Network, etc.)
90
90
- doc
91
91
- A folder with documentation
92
-
- dev-setup
93
-
- A folder with scripts helping to configure development environment (python, dependencies, projects, virtual environment)
92
+
- .devcontainer
93
+
- A folder with scripts helping to configure a [development environment](#how-to-start-working-with-the-code). Please refer to the official [DevContainer documentation](https://containers.dev/) for more information.
94
+
94
95
95
96
## Dependent Projects
96
97
@@ -144,10 +145,19 @@ The described process is automated in one of the ways below (it allow to install
144
145
-**Also coming soon:** Create virtual machines in AWS.
145
146
146
147
147
-
148
148
## How to Start Working with the Code
149
149
150
-
Please have a look at [Dev Setup](docs/source/setup-dev.md)
150
+
The preferred method of setting up the development environment is to use the **devcontainers**.
151
+
All configuration files for VSCode and [Gitpod](https://gitpod.io) are already placed in this repository.
152
+
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.
153
+
154
+
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.
155
+
If VSCode didn't ask to open it, open the command palette and use the `Remote-Containers: Rebuild and Reopen in Container` command.
156
+
157
+
If you want to use Gitpod simply use this [link](https://gitpod.io/#https://github.com/hyperledger/indy-node/tree/main)
158
+
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`.
159
+
160
+
**Note**: Be aware that the config files for Gitpod and VSCode are currently only used in the `main` branch!
0 commit comments