Skip to content

Commit b57af4c

Browse files
Clarify README app entry note
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
1 parent 6c8485b commit b57af4c

3 files changed

Lines changed: 21 additions & 1 deletion

File tree

.evidence/readme-before.png

34.3 KB
Loading

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ npm run dev
99

1010
## Notes
1111

12-
- [App.svelte](https://github.com/fastrepl/contextlengthof/blob/main/src/App.svelte) is all you need to edit.
12+
- [App.svelte](https://github.com/fastrepl/contextlengthof/blob/main/src/App.svelte) contains the main app code.
1313
- [PicoCSS](https://picocss.com/) is used for styling.

scripts/verify-readme.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
from pathlib import Path
2+
3+
4+
readme = Path(__file__).resolve().parents[1] / "README.md"
5+
content = readme.read_text()
6+
7+
expected = (
8+
"[App.svelte](https://github.com/fastrepl/contextlengthof/blob/main/src/App.svelte) "
9+
"contains the main app code."
10+
)
11+
12+
if expected not in content:
13+
raise SystemExit(
14+
"README should describe App.svelte as containing the main app code."
15+
)
16+
17+
if "is all you need to edit" in content:
18+
raise SystemExit("README should not imply App.svelte is always the only file to edit.")
19+
20+
print("PASS: README clearly describes App.svelte.")

0 commit comments

Comments
 (0)