write_readme {rUM}R Documentation

Create a project README file

Description

This function streamlines project documentation by creating and managing a README.md file. It provides interactive prompts for existing files and maintains consistent project documentation structure.

Usage

write_readme(path = here())

Arguments

path

The destination directory for the README file. Defaults to here::here().

Details

The README.md template includes structured sections for:

If the README file already exists, the function will stop and warn the user. The templates include example documentation that can be modified to suit project needs.

Value

Creates a comprehensive README template for project documentation.

Examples

# Create new README in temporary directory
tmp <- tempdir()
write_readme(path = tmp)

[Package rUM version 2.2.0 Index]