Skip to content

Commit ebc3e8c

Browse files
authored
Update README.md
1 parent 8c1c61a commit ebc3e8c

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,21 @@ This repository serves as a blank template to create your own Strudel sample pac
55
## How it works
66

77
- Fork this repository to start your own sample pack.
8-
- Add your samples into folders, organize them however you like.
8+
- Create a new branch with the name of your sample pack.
9+
- Add your samples into folders.
910
- The repository includes a GitHub Action that automatically generates a strudel.json file containing all your samples.
1011
- Once the workflow runs, strudel.json is auto-committed to your repository and is ready to be used in Strudel.
1112

1213
The JSON file reflects the folder structure of your samples, so Strudel can serve them directly in your session.
1314

15+
## How to load samples
16+
17+
```
18+
The format is samples('github:<user>/<repo>/<branch>').
19+
```
20+
21+
Refer to strudel's doc for more info about samples https://strudel.cc/learn/samples/
22+
1423
## Troubleshooting
1524

1625
- If strudel.json is not generated, check the Actions tab in GitHub for any workflow errors.

0 commit comments

Comments
 (0)