Skip to content

Commit 2a19c4c

Browse files
committed
Refine text
1 parent 0a1958b commit 2a19c4c

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
# Executable Tutorials
22

3+
## Use Cases
4+
35
Many organizations maintain collections of tutorials addressing realistic
46
problems in a science domain, with runnable code examples written and
5-
kept current by experts in the tools.
7+
kept current by experts in the tools. They are useful as:
68

79
- A trove of working snippets to copy and paste
810
- A maintained resource for self-guided learning
911
- A ready-to-use curriculum for interactive workshops
1012
- A suite of science domain-specific "integration tests"
1113

12-
This repository demonstrates one way to configure a collection. It emphasizes the
13-
following features:
14+
## Key Features
15+
16+
This repository demonstrates one way to configure a collection of tutorials,
17+
covering some core features:
1418

1519
- Source is in [MyST Markdown][] which is easy for humans to edit and review.
1620
- The executed examples---code and results---are published as a static site.
@@ -19,6 +23,7 @@ following features:
1923
- In a user's local environment
2024
- On a Binder ([example][binder example])
2125
- (Experimental) In the user's browser via Jupyter Lite ([example][jupyterlite example])
26+
- The examples can be tested using `pytest`, both locally and on CI.
2227

2328
The repository also includes a [Guide to Contributing][] tutorials. This
2429
provides for a good overview of what this is like to use.

0 commit comments

Comments
 (0)