Skip to content

Update README: refresh content and align style with mikeio - #704

Merged
ecomodeller merged 1 commit into
mainfrom
readme-align-mikeio
Aug 27, 2026
Merged

Update README: refresh content and align style with mikeio#704
ecomodeller merged 1 commit into
mainfrom
readme-align-mikeio

Conversation

@ecomodeller

Copy link
Copy Markdown
Member

Summary

The README had stale content and had drifted from the mikeio README in structure.

Fixed content:

  • Skill table output was stale; regenerated by running the example against docs/data/SW
  • Stated Python 3.12 - 3.14 (was unstated)
  • Dropped the hand-maintained list of 7 nbviewer notebook links (a subset of the 28 notebooks in notebooks/, duplicating the examples gallery) and the inline plot images, both of which live on the Quarto site
  • connect wording replaced with match; "comparer object" corrected to ComparerCollection

Aligned with mikeio:

  • Same section order: Requirements, Installation, Getting started, Where can I get help?, Testing, Contributing, License
  • License badge, linked test badge, OS badge; install commands in fenced blocks
  • Coverage figure (~90%) measured locally

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ecomodeller
ecomodeller merged commit 15b4265 into main Aug 27, 2026
10 checks passed
@ecomodeller
ecomodeller deleted the readme-align-mikeio branch August 27, 2026 09:36
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