Repository navigation
Slim the README and move detailed content into docs/ - #18
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015NAUQm8LQftjtRw8cqdSq7
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Ehsan · project thread
Before: the README was ~3,960 lines covering install, interface, every physics model, validation and design.
After: the README is ~110 lines (main features, install/run, a Python snippet, screenshots, a docs table). The detailed content moved unchanged into
docs/getting-started.md,docs/interface.md,docs/physics.md,docs/validation.mdanddocs/design.md.How: sections were split by line range with a script; relative links were rewritten for the new location and in-page anchors now point to whichever doc holds the target. The component count and "more than N tests" phrasing stay in the README so the packaging drift guards still hold.
🤖 Generated with Claude Code
https://claude.ai/code/session_015NAUQm8LQftjtRw8cqdSq7
Generated by Claude Code