Function cargo_readme::generate_readme[][src]

pub fn generate_readme<T: Read>(
    project_root: &Path,
    source: &mut T,
    template: Option<&mut T>,
    add_title: bool,
    add_badges: bool,
    add_license: bool,
    indent_headings: bool
) -> Result<String, String>

Generates readme data from source file

Optionally, a template can be used to render the output