Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .evidence/readme-after.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .evidence/readme-before.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ npm run dev

## Notes

- [App.svelte](https://github.com/fastrepl/contextlengthof/blob/main/src/App.svelte) is all you need to edit.
- [App.svelte](https://github.com/fastrepl/contextlengthof/blob/main/src/App.svelte) contains the main app code.
- [PicoCSS](https://picocss.com/) is used for styling.
20 changes: 20 additions & 0 deletions scripts/verify-readme.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
from pathlib import Path


readme = Path(__file__).resolve().parents[1] / "README.md"
content = readme.read_text()

expected = (
"[App.svelte](https://github.com/fastrepl/contextlengthof/blob/main/src/App.svelte) "
"contains the main app code."
)

if expected not in content:
raise SystemExit(
"README should describe App.svelte as containing the main app code."
)

if "is all you need to edit" in content:
raise SystemExit("README should not imply App.svelte is always the only file to edit.")

print("PASS: README clearly describes App.svelte.")
Loading