setup_readme: Setup README with Disclaimer in Project

setup_readmeR Documentation

Setup README with Disclaimer in Project

Description

'setup_readme()' establishes a README.md with the standard USAID disclaimer (or appends to one that currently exists). This function can be used as a stand alone function but primarily serves 'si_setup()'.

Usage

setup_readme(add_disclaimer = TRUE)

Arguments

add_disclaimer

should the standard disclaimer be added, default = TRUE

Value

adds/appends disclaimer to README

See Also

Other project setup: folder_setup(), setup_gitignore(), si_setup()

Examples

## Not run: 
#standard (appends dislaimer if README exists)
  setup_readme() 
## End(Not run)

USAID-OHA-SI/glamr documentation built on Oct. 1, 2024, 2:18 p.m.