Skip to content

Commit 1c9e0be

Browse files
apachaclaude
andcommitted
Document --pdf-links and --check flags in README
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent d166388 commit 1c9e0be

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ Pushing to `master` triggers `.github/workflows/deploy.yml`, which runs `generat
5151
### Generating the HTML files locally
5252

5353
```bash
54-
python3 generate_site.py
54+
python3 generate_site.py # standard output
55+
python3 generate_site.py --pdf-links # local review: adds a PDF chip to each entry
56+
python3 generate_site.py --check # sanity-check only, no output files written
5557
```
5658

5759
This produces three HTML files:
@@ -62,6 +64,8 @@ This produces three HTML files:
6264
| `omr-related-research.html` | `OMR-Related-Research.bib` | Related (non-OMR-primary) works |
6365
| `omr-research-unverified.html` | `OMR-Research-Unverified.bib` | Unverified entries |
6466

67+
The `--pdf-links` flag adds a red **PDF** badge next to the DOI/arXiv chips for every entry whose `file` field contains a local PDF path (as stored by JabRef). This gives one-click access to the papers when browsing locally. The flag is off by default so the public website is unaffected.
68+
6569
[RenderWebsite.sh](RenderWebsite.sh) is a convenience wrapper that calls the same command.
6670

6771
### Reviewing changes since a baseline commit

0 commit comments

Comments
 (0)