Skip to contents

If you did not initiate your project using `projectlog::initiate_project()`, you can use this function to generate a README file that will be placed at the highest level of your repository. It will include example text for a description of your project, an overview of the (most important) folders, and code to generate an overview of your project milestones.

Usage

add_project_readme(path = getwd())

Arguments

path

Character, path to project repository.

Value

A README.Rmd file at the highest level of your repository