Skip to contents

Build README.md from the README.qmd template, incorporating package metadata.

Usage

build_readme(
  base_path = NULL,
  verbose = TRUE,
  overwrite = TRUE,
  quarto = FALSE
)

Arguments

base_path

Base path for the project

verbose

Whether to show messages

overwrite

Whether to overwrite README.qmd found at base_path

Value

Path to generated README