Move funder acknowledgements from CITATION.cff to README.md

[alexdewar]

Description

I used the CITATION.cff from this repo as a template for the one in FROG and @dalonsoa pointed out a couple of things:

1. A typo
2. That funder acknowledgements are probably better in README.md

The logic is that funder acknowledgements aren't really part of the citation and if you include them in the README.md you can also include links to the grant pages. So it's probably a better approach overall. Note that the README.md is included in any source bundle for the release (which you get on Zenodo), so the information is still there.

I've changed this repo to use the same convention. The "overview" text is duplicated between README.md and docs/README.md, so while I was at it, I changed things to use mdBook's include pre-processor, which removes the need to keep the two in sync.

Note that this won't retrospectively affect the entry on Zenodo for the v2.1.0 release (which is fine), but I thought I'd do it now so that I didn't forget for the next release.

Type of change

• Bug fix (non-breaking change to fix an issue)
• New feature (non-breaking change to add functionality)
• Refactoring (non-breaking, non-functional change to improve maintainability)
• Optimization (non-breaking change to speed up the code)
• Breaking change (whatever its nature)
• Documentation (improve or add documentation)

Key checklist

• All tests pass: $ cargo test
• The documentation builds and looks OK: $ cargo doc
• Update release notes for the latest release if this PR adds a new feature or fixes a bug
  present in the previous release

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[Copilot]

Pull request overview

Updates project metadata/documentation so funding acknowledgements live in the README (not the citation metadata), and avoids duplicating the “Overview” text between the repository README and the mdBook docs landing page.

Changes:

• Removed funder acknowledgement text from CITATION.cff’s message field, keeping it focused on citation guidance.
• Added funder acknowledgement (with a grant link) to the “Overview” section in README.md.
• Replaced duplicated overview prose in docs/README.md with an mdBook {{#include ...}} of the anchored “Overview” section from README.md.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File	Description
docs/README.md	Uses mdBook include to pull the shared Overview text from the repo README.md.
README.md	Adds an anchored Overview block and moves funder acknowledgements here (with a grant link).
CITATION.cff	Removes funding acknowledgement from the citation message and simplifies the message text.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.74%. Comparing base (d8e7627) to head (fde0a06).
⚠️ Report is 15 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1253   +/-   ##
=======================================
  Coverage   89.74%   89.74%           
=======================================
  Files          57       57           
  Lines        8195     8195           
  Branches     8195     8195           
=======================================
  Hits         7355     7355           
  Misses        544      544           
  Partials      296      296           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.