Skip to content

Commit 98aba87

Browse files
authored
Update README.md
1 parent da25e87 commit 98aba87

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1-
# DataJoint interactive tutorial
2-
Getting started materials for DataJoint - with Calcium Imaging, Electrophysiology, Machine Learning examples
1+
# DataJoint interactive tutorial using GitHub Codespaces
2+
3+
### This README is the guide to setting up an interactive tutorial on DataJoint basics using GitHub Codespaces. Please follow the steps below for the best experience:
4+
5+
1. Fork this repository to your own GitHub account.
6+
7+
2. Click on the green `Code` button where you would typically click to clone a repository.
8+
9+
3. Within the dropdown menu, click on the `Codespaces` tab.
10+
11+
4. If this is your first time using Codespaces with this repository, please click on the green `Create codespace on master` button.
12+
13+
5. Wait for the environment to be created. This step takes ~ 5 minutes. You will know the environment is ready when a Visual Studio Code window is rendered within your browser. If you are new to Visual Studio Code, please take a minute to familiarize yourself with the layout. The directories you will need to navigate are on the left side of the screen by default.
14+
15+
6. Navigate to the 00-Getting_started directory and open the `00-Getting started.ipynb` Jupyter Notebook. Execute the cells in this notebook to being your walk through the tutorials.
16+
17+
We recommend finishing all notebooks in `Getting_started` before proceeding to `Calcium_imaging` and `Electrophysiology`. Once you are done, GitHub will automatically terminate the Codespace after 30 minutes of inactivity or you can manually terminate the Codespace.
18+
19+
If you are new to GitHub and run into any errors, please contact us via email. 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.
20+
21+
**Please Note:**
22+
23+
```GitHub Codespaces are limited to 120 hours per month for free users. Once you exceed this limit, you will have to wait for the hours to reset or pay to use Codespaces.```
324

0 commit comments

Comments
 (0)