Skip to content

Harmonise README: badges, See also, License footer#8

Merged
mstorath merged 1 commit into
mainfrom
claude/readme-harmonisation-2026-05
May 11, 2026
Merged

Harmonise README: badges, See also, License footer#8
mstorath merged 1 commit into
mainfrom
claude/readme-harmonisation-2026-05

Conversation

@mstorath
Copy link
Copy Markdown
Owner

Summary

Part of the cross-repo README harmonisation pass (Pass F). CSSD already followed the family template style — this is a light-touch update.

  • Add badge block (PyPI / Python / License / CI / MATLAB)
  • Add a TL;DR sentence above the abstract
  • Expand "See also" from 4 entries to 5 siblings + 2 external (pcw-regrs, HOMS)
  • Add "How to cite" line referencing CITATION.cff
  • License footer

Math blocks and example sections preserved verbatim (LaTeX equation blocks not modified per project rule).

Test plan

  • Render preview looks correct
  • All in-repo links resolve
  • Math renders correctly

@mstorath mstorath merged commit a953d55 into main May 11, 2026
9 checks passed
@mstorath mstorath deleted the claude/readme-harmonisation-2026-05 branch May 11, 2026 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant