Skip to content

Flesh out README (#48)#51

Open
dbqpdb wants to merge 1 commit into
masterfrom
docs/readme
Open

Flesh out README (#48)#51
dbqpdb wants to merge 1 commit into
masterfrom
docs/readme

Conversation

@dbqpdb

@dbqpdb dbqpdb commented May 14, 2026

Copy link
Copy Markdown
Owner

Summary

Expands the one-line README into a project README that covers:

  • What RLM is and its design ethos (kept the original playful tone).
  • Installation via conda env create -f environment.yml, with a forward-reference to Refactor: reconsider numpy and pandas dependencies #39 (dependency trimming).
  • How to play a game.
  • How to run tests (with a note about the in-flight pytest migration Unit testing #23).
  • Contributing notes — PR-only workflow, CI expectations.
  • Roadmap pointing at concrete tracking issues.
  • Non-goals (playing well; silently).

Notes

  • References issues that are already filed; doesn't reference any PR numbers since they're less stable.
  • Mentions pytest as the going-forward test runner. Strictly speaking pytest isn't on master until Test infra: pytest migration + tests / lint workflows (#23, #43, #44) #50 lands, but the README is forward-looking and the migration is in flight.
  • The "PEP 8 work in progress" line in Contributing softens what the lint workflow will surface on incoming PRs.

🤖 Generated with Claude Code

Adds installation, gameplay, testing, contributing, roadmap, and
non-goals sections. References the in-flight issues so the README
documents both the current and intended state. Keeps the original
playful tone in the intro and non-goals.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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