Documentation
¶
Overview ¶
Package projectreadme scaffolds the per-project README.md at the workspace root. The file is written exactly once — on `maestro init` — and afterwards belongs entirely to the developer. `maestro refresh` never touches it, so any prose, badges, or AI-agent notes the team adds survive.
Index ¶
Constants ¶
const FileName = "README.md"
FileName is the file this package writes at the project root.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
ProjectName string
RepoOwner string
Containerized bool
HotReload bool
UsesDoppler bool
DopplerProject string
}
Options carries the project settings needed to render a useful starter README — the project name shows up in the title, and the dev/secrets flags decide which commands to document.
func FromConfig ¶
FromConfig builds Options from the in-memory config the project Init flow already has. It keeps the call site in project.go a one-liner.
type ProjectReadme ¶
type ProjectReadme struct {
// contains filtered or unexported fields
}
ProjectReadme writes the starter README at a project root.
func New ¶
func New(rootPath string, opts Options) *ProjectReadme
func (*ProjectReadme) Initialize ¶
func (p *ProjectReadme) Initialize() (bool, error)
Initialize writes README.md when the project has none, and is a no-op when one already exists. Reports whether the file was created.
Source Files