Skip to content

docs: expand README with background, objectives, and quickstart#2

Merged
stedrew merged 2 commits intomainfrom
docs/improve-readme
Mar 4, 2026
Merged

docs: expand README with background, objectives, and quickstart#2
stedrew merged 2 commits intomainfrom
docs/improve-readme

Conversation

@stedrew
Copy link
Copy Markdown
Contributor

@stedrew stedrew commented Mar 4, 2026

Summary

  • Replaces the two-line placeholder README with a proper project description
  • Adds project background, research objectives, quickstart instructions, and parameter sweep usage
  • Adds CLAUDE.md with architecture and development guidance for Claude Code

Closes #1

Steve Drew and others added 2 commits March 3, 2026 23:47
Closes #1

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@stedrew stedrew requested a review from legend5teve March 4, 2026 06:49
@stedrew stedrew self-assigned this Mar 4, 2026
@stedrew stedrew merged commit 07422b4 into main Mar 4, 2026
@stedrew stedrew deleted the docs/improve-readme branch March 4, 2026 06:49
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.

README lacks project description, setup instructions, and usage documentation

1 participant