Skip to content

Generate project README.md during trellis new#661

Open
retlehs wants to merge 1 commit intomasterfrom
feature/new-generate-readme
Open

Generate project README.md during trellis new#661
retlehs wants to merge 1 commit intomasterfrom
feature/new-generate-readme

Conversation

@retlehs
Copy link
Copy Markdown
Member

@retlehs retlehs commented Apr 1, 2026

Summary

  • Generates a README.md in the project root during trellis new with project-specific values (site name, host, environment URLs)
  • Includes Requirements, Local development setup, Deployment, and Documentation sections
  • Skips generation if a README.md already exists

Closes #11

Example output

For trellis new example.com:

example.com

Environment URL
Development https://example.test
Production https://example.com

Requirements

Local development setup

  1. Clone this repository
  2. Run trellis init to set up the virtual environment
  3. Run trellis vm start to start the development server
  4. Visit example.test

Deployment

$ trellis deploy <environment>

Documentation

🤖 Generated with Claude Code

@retlehs retlehs self-assigned this Apr 1, 2026
Add README generation with project-specific values (site name, host,
environment URLs) including Requirements, Local development setup,
Deployment, and Documentation sections. Skips if README.md already exists.

Closes #11

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@retlehs retlehs force-pushed the feature/new-generate-readme branch from 333eb3b to a6622b8 Compare April 1, 2026 18:33
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.

Auto-generated README with information/documentation

1 participant