Skip to content

Harmonise README + clean LICENSE clause#8

Merged
mstorath merged 2 commits into
masterfrom
claude/readme-harmonisation-2026-05
May 11, 2026
Merged

Harmonise README + clean LICENSE clause#8
mstorath merged 2 commits into
masterfrom
claude/readme-harmonisation-2026-05

Conversation

@mstorath

Copy link
Copy Markdown
Owner

Summary

Part of the cross-repo README harmonisation pass (Pass F), plus a LICENSE cleanup.

Two commits on this branch:

  1. Harmonise README — full rewrite. The old README (31 lines) was MATLAB-only and made no mention of the dcebe PyPI package despite the package living in this same repo.

    • Add badge block (PyPI / Python / License / CI / MATLAB / File Exchange)
    • Title with TL;DR sentence under hero image
    • Paper citation block at top
    • Python quickstart with estimate_bat
    • MATLAB section preserved
    • Driscoll finite-difference-weights acknowledgement preserved
    • Standardise "See also" to all five sibling repos
    • License footer (Apache-2.0)
    • "Project history" footer mentions Python port and links to PORTED_BY.md
  2. Drop non-standard citation clause from LICENSE — the LICENSE file added "if this code is used in any scientific publication, the following paper shall be cited" on top of Apache-2.0. The CITATION.cff and pyproject.toml both declare pure Apache-2.0. Citation request stays in CITATION.cff and README; LICENSE now matches the SPDX expression declared elsewhere in the repo.

Test plan

  • Render preview looks correct
  • Code snippet runs (from dcebe import estimate_bat)
  • License-detector (GitHub sidebar) now identifies the repo as Apache-2.0 cleanly
  • Badges resolve once package is on PyPI

mstorath added 2 commits May 11, 2026 06:40
Citation request lives in CITATION.cff and README.md; the LICENSE file
should reflect the SPDX license declared in pyproject.toml and
CITATION.cff (Apache-2.0) without modification.
@mstorath mstorath merged commit a3f50fe into master May 11, 2026
5 checks passed
@mstorath mstorath deleted the claude/readme-harmonisation-2026-05 branch May 11, 2026 08:10
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