Skip to content

Commit 7ce3acb

Browse files
committed
Update readme
1 parent f4367ce commit 7ce3acb

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,30 +23,28 @@ Interactive tutorials on the DataJoint framework, in Python. Throughout this set
2323
- `.populate()` for automated computation
2424
- `.populate(reserve_jobs=True)` for parallelization
2525

26-
2726
## Getting started
2827

29-
The easiest way to start this interactive tutorial on DataJoint basics is to use [GitHub Codespace](https://docs.github.com/en/codespaces/overview). Please follow the steps below for the best experience:
30-
31-
1. Fork this repository to your own GitHub account.
28+
The easiest way to learn about the basics of DataJoint is to use these tutorial notebooks within a [GitHub Codespace](https://docs.github.com/en/codespaces/overview). Please follow the steps below for the best experience:
3229

33-
2. Click on the green `Code` button where you would typically click to clone a repository.
30+
1. Fork this repository to your GitHub account.
3431

35-
3. Within the dropdown menu, click on the `Codespaces` tab.
32+
2. Select the green `Code` button.
3633

37-
4. If this is your first time using Codespaces with this repository, please click on the green `Create codespace on master` button.
34+
3. Within the dropdown menu, select the `Codespaces` tab.
3835

39-
5. Wait for the environment to be created. This step takes ~5 minutes the very first time being launched, and typically around ~1 minute if you revisit this codespace again in the future.
36+
4. Select the green `Create codespace on main` button.
4037

41-
6. 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.
38+
5. The environment is ready when a Visual Studio Code window is rendered within your browser. This takes ~5 minutes the first time being launched, and ~1 minute if you revisit this Codespace.
4239

43-
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.
40+
6. Navigate to the `00-Getting_Started` directory on the left panel and open the `00-Getting Started.ipynb` Jupyter notebook. Execute the cells in this notebook to begin your walk through the tutorials. We recommend finishing all notebooks in `00-Getting_Started` before proceeding to `01-Calcium_Imaging` and `02-Electrophysiology`.
4441

45-
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.
42+
7. Once you are done, GitHub will automatically stop the Codespace after 30 minutes of inactivity or you can manually stop the Codespace.
4643

47-
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.
44+
8. After stopping the Codespace, we recommend deleting the Codespace to save on storage costs, which are free for the first 15 GB-month.
4845

49-
**Please Note:**
46+
+ 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 explanation of the error and proposed solution.
5047

51-
```GitHub Codespaces are limited to 120 core 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.```
48+
**Please Note:**
5249

50+
+ GitHub Codespaces are limited to 120 core-hours per month and 15 GB-month for free users. Once you exceed this limit, you will have to wait for the hours to reset or pay to use Codespaces.

0 commit comments

Comments
 (0)