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
docs(readme)📝: improve quick start instructions for running notebooks
- Add step-by-step quick start guide for installing uv and running notebooks.
- Clarify use of the --sandbox flag for isolated environments.
- Update website reference for more detailed information.
Copy file name to clipboardExpand all lines: README.md
+19-2Lines changed: 19 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,26 @@ in a variety of formats (ranging from 1.5 hr to 4 hour long workshops).
10
10
The material is designed for a live tutorial presentation,
11
11
with the code available for you to reference afterwards.
12
12
13
-
## Getting Started
13
+
## Quick Start
14
+
15
+
To get started with the notebooks, follow these simple steps:
16
+
17
+
1.**Install uv** (the Python package manager):
18
+
Follow the installation instructions at [https://docs.astral.sh/uv/getting-started/installation/](https://docs.astral.sh/uv/getting-started/installation/)
19
+
20
+
2.**Navigate to the notebook directory**:
21
+
```bash
22
+
cd notebooks/subdir/
23
+
```
24
+
25
+
3.**Run the notebook**:
26
+
```bash
27
+
uvx marimo edit --sandbox <notebook_name>.py
28
+
```
29
+
30
+
That's it! The `--sandbox` flag ensures a clean, isolated environment for running the notebooks.
14
31
15
-
Head over to [the official website][nams]!
32
+
For more detailed information, head over to [the official website][nams]!
0 commit comments