Skip to content

Commit ed7f3a4

Browse files
committed
Update README
1 parent e0a0ab9 commit ed7f3a4

1 file changed

Lines changed: 0 additions & 12 deletions

File tree

README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ torchfinder/
4242
deploy.yml CI/CD pipeline
4343
```
4444

45-
---
46-
4745
## Build
4846

4947
The build script (`build.ts`) runs in Deno and does four things:
@@ -69,14 +67,10 @@ The `staging/` directory is what gets deployed to the `gh-pages` branch. The rep
6967

7068
If any step fails, the script exits with a nonzero code and does not write to `staging/`. A failed build never takes down the live site.
7169

72-
---
73-
7470
## Local setup and contributing
7571

7672
See [CONTRIBUTING.md](CONTRIBUTING.md) for local development setup, code conventions, and the PR process.
7773

78-
---
79-
8074
## Deployment
8175

8276
Deployment is fully automated via GitHub Actions (`.github/workflows/deploy.yml`).
@@ -89,8 +83,6 @@ On a successful build, the `staging/` directory is force-pushed to the `gh-pages
8983

9084
After a successful deploy, the workflow automatically tags the commit with the current UTC date in CalVer format. If a tag for today already exists, a numeric patch suffix is appended and incremented (`2026.02.25``2026.02.25.1``2026.02.25.2`, etc.). No manual tagging needed.
9185

92-
---
93-
9486
## Connection to torchfinder-data
9587

9688
`build.ts` fetches:
@@ -105,14 +97,10 @@ This is the validated artifact produced by `torchfinder-data`'s own build step.
10597

10698
**To report a data issue** in a specific entry: use the "Report an issue" link on the expanded entry card — it pre-fills a GitHub issue on `torchfinder-data` with the entry ID.
10799

108-
---
109-
110100
## Versioning
111101

112102
Both repos use [CalVer](https://calver.org/): tags follow `YYYY.MM.DD` with an optional patch suffix (e.g., `2026.02.24.1`) for multiple releases on the same day. Tagging is automatic — the deployment workflow tags each successful deploy with the current UTC date, incrementing the patch suffix as needed.
113103

114-
---
115-
116104
## License
117105

118106
All contributions to this repository are licensed under [MIT](LICENSE).

0 commit comments

Comments
 (0)