readme

allframe_forge::templates::basic

Function readme 

Source 
pub fn readme(project_name: &str) -> String
Expand description

Generate README.md content for the project

Creates comprehensive project documentation including:

  • Quick start guide
  • Project structure explanation
  • Feature highlights

§Arguments

  • project_name - Name of the project (used in title)

§Returns

A formatted README.md file content as a String