Function Readme

internal/plugin/info.go:19–60

(ctx context.Context,
	pkg *devpkg.Package,
	projectDir string,
	markdown bool,
)

)

func Readme(ctx context.Context,
	pkg *devpkg.Package,
	projectDir string,
	markdown bool,
) (string, error) {
	defer trace.StartRegion(ctx, "Readme").End()

	cfg, err := getConfigIfAny(pkg, projectDir)
	if err != nil {
		return "", err
	}

	if cfg == nil {
		return "", nil
	}

	buf := bytes.NewBuffer(nil)

	_, _ = fmt.Fprintln(buf, "")

	if err = printReadme(cfg, buf, markdown); err != nil {
		return "", err
	}

	if err = printServices(cfg, pkg, buf, markdown); err != nil {
		return "", err
	}

	if err = printCreateFiles(cfg, buf, markdown); err != nil {
		return "", err
	}

	if err = printEnv(cfg, buf, markdown); err != nil {
		return "", err
	}

	if err = printInfoInstructions(pkg.CanonicalName(), buf); err != nil {
		return "", err
	}

	return buf.String(), nil
}

func printReadme(cfg *Config, w io.Writer, markdown bool) error {
	if cfg.Description() == "" {