Skip to content

Commit 9e6335e

Browse files
committed
Add LiterateCheck README entry
1 parent d61f5f1 commit 9e6335e

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,3 +153,24 @@ jobs:
153153
name: "Format Suggestions"
154154
uses: "ITensor/JuliaActions/workflows/FormatSuggest.yml@main"
155155
```
156+
157+
## LiterateCheck
158+
159+
The LiterateCheck workflow is designed to keep the README of Julia packages up to date.
160+
The workflow would look like:
161+
162+
```yaml
163+
name: "Literate Check"
164+
165+
on:
166+
push:
167+
branches:
168+
- 'main'
169+
tags: '*'
170+
pull_request:
171+
172+
jobs:
173+
format-check:
174+
name: "Literate Check"
175+
uses: "ITensor/JuliaActions/workflows/LiterateCheck.yml@main"
176+
```

0 commit comments

Comments
 (0)