Skip to content

Commit c4c6f99

Browse files
committed
How do I use it?
1 parent 2a19c4c commit c4c6f99

File tree

3 files changed

+31
-4
lines changed

3 files changed

+31
-4
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,38 @@ covering some core features:
2525
- (Experimental) In the user's browser via Jupyter Lite ([example][jupyterlite example])
2626
- The examples can be tested using `pytest`, both locally and on CI.
2727

28-
The repository also includes a [Guide to Contributing][] tutorials. This
29-
provides for a good overview of what this is like to use.
28+
## Try It Out
29+
30+
- Read the [published examples][static site example].
31+
32+
- Open it on [Binder][binder example] to run the examples in the cloud.
33+
34+
- Download and run the examples locally.
35+
36+
```sh
37+
git clone https://github.com/scientific-python/executable-tutorials
38+
```
39+
40+
For users of [pixi][]:
41+
42+
```sh
43+
pixi run start
44+
```
45+
46+
Alternatively, install the requirements with pip and start JupyterLab.
47+
48+
```sh
49+
pip install -r requirements.txt
50+
jupyter lab
51+
```
52+
53+
## Make Your Own
54+
55+
See the [Guide for Maintainers][] to create your own collection of tutorials.
3056

3157
[Myst Markdown]: https://mystmd.org/guide/typography
3258
[static site example]: https://scientific-python.github.io/exeuctable-tutorials/
3359
[binder example]: https://mybinder.org/v2/gh/scientific-python/executable-tutorials/main
3460
[jupyterlite example]: https://scientific-python.github.io/executable-tutorials/jupyterlite/lab/index.html
35-
[Guide to Contributing]: https://scentific-python.org/executable-tutorials/contributing.html
61+
[pixi]: https://pixi.sh/
62+
[Guide for Maintainers]: https://scientific-python.github.io/executable-tutorials/maintainer-guide.html

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ caption: Contributing
2424
---
2525
2626
contributing
27-
maintainers
27+
maintainer-guide
2828
```
File renamed without changes.

0 commit comments

Comments
 (0)