Skip to content

Commit 36cce12

Browse files
authored
Merge pull request #21 from ttngu207/master
Added instruction for local IDE (VSCode) setup
2 parents 3ccdd4b + 0f66a31 commit 36cce12

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,15 @@ The easiest way to start this interactive tutorial on DataJoint basics is to use
4242

4343
7. Navigate to the 00-Getting_started directory and open the `00-Getting started.ipynb` Jupyter Notebook. Execute the cells in this notebook to begin your walk through the tutorials.
4444

45+
- **Local IDE**:
46+
- Ensure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
47+
- Ensure you have [Docker](https://docs.docker.com/get-docker/)
48+
- Ensure you have [VSCode](https://code.visualstudio.com/)
49+
- Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
50+
- `git clone` the codebase repository and open it in VSCode
51+
- Use the `Dev Containers extension` to `Reopen in Container` (More info in the `Getting started` included with the extension)
52+
- You will know your environment has finished loading once you see a terminal open related to `Running postStartCommand` with a final message: `Done`.
53+
4554
We recommend finishing all notebooks in `00-Getting_started` before proceeding to `01-Calcium_imaging` and `02-Electrophysiology`. Once you are done, GitHub will automatically terminate the Codespace after 30 minutes of inactivity or you can manually terminate the Codespace.
4655

4756
If you are new to GitHub and run into any errors, please contact us via email at [email protected]. If you are experienced with GitHub, please create an issue on the upstream repository or issue a pull request with a thorough explanantion of the error and proposed solution.

0 commit comments

Comments
 (0)