Skip to content

Update generated README and template README#71

Open
phinate wants to merge 2 commits intopr10-copier-streamlinefrom
pr11-readme
Open

Update generated README and template README#71
phinate wants to merge 2 commits intopr10-copier-streamlinefrom
pr11-readme

Conversation

@phinate
Copy link
Copy Markdown
Collaborator

@phinate phinate commented Mar 19, 2026

Summary

Generated README:

  • Add CI, PyPI, Python version, and license badges (templated from copier variables)
  • Add quickstart section with TODO placeholder
  • Replace pip install / python -m pip install . with uv-native development commands
  • Remove references to backend, poetry, and legacy tooling

Template README:

  • Rewrite to reflect uv-native, ty-enabled, opinionated workflow
  • Document all copier variables in a table
  • Show generated project structure
  • Document development workflow commands

Also:

  • Make CODE_OF_CONDUCT.md unconditional (removed coc variable dependency)

Test plan

  • Generated README renders correctly on GitHub
  • All badge URLs resolve (CI badge may 404 until first workflow runs)
  • No broken Copier template variables ({{ ... }} literals) in rendered output
  • The development commands listed in the README all work in a freshly generated project

🤖 Generated with Claude Code

phinate and others added 2 commits March 19, 2026 13:02
Generated README:
- Add CI, PyPI, Python version, and license badges
- Add quickstart section with TODO placeholder
- Replace pip install commands with uv-native workflow
- Remove references to legacy tooling

Template README:
- Rewrite to reflect uv-native, ty-enabled workflow
- Document all copier variables in a table
- Show generated project structure
- Document development workflow commands

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove coc template conditional since the coc question was removed
from copier.yml. Always include the standard Code of Conduct.

Co-Authored-By: Claude Opus 4.6 <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