# readme

URL: /kida/api/readme/
Section: readme
Description: Kida README generator — auto-detect project metadata, render styled READMEs.

---

> For a complete page index, fetch /kida/llms.txt.

Open LLM text
(/kida/api/readme/index.txt)

Share with AI

Ask Claude
(https://claude.ai/new?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fkida%2Fapi%2Freadme%2Findex.txt)

Ask ChatGPT
(https://chatgpt.com/?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fkida%2Fapi%2Freadme%2Findex.txt)

Ask Gemini
(https://gemini.google.com/app?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fkida%2Fapi%2Freadme%2Findex.txt)

Ask Copilot
(https://copilot.microsoft.com/?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fkida%2Fapi%2Freadme%2Findex.txt)

Module

#
`readme`

Kida README generator — auto-detect project metadata, render styled READMEs.

2Functions

## Functions

`detect_project`

2

`ProjectContext`

▼

Auto-detect project metadata from a directory.

Convenience re-export of `detec…

`def detect_project(root: Path, *, depth: int = 2) -> ProjectContext`

Auto-detect project metadata from a directory.

Convenience re-export of`detect_project`().

##### Parameters

Name
Type
Description

`root`
`Path`

`depth`
`int`

Default:`2`

##### Returns

`ProjectContext`

`render_readme`

5

`str`

▼

Auto-detect project metadata and render a README.

`def render_readme(root: Path, *, preset: str = 'default', template: Path | None = None, context: dict[str, Any] | ProjectContext | None = None, depth: int = 2) -> str`

##### Parameters

Name
Type
Description

`root`
`Path`

Project root directory to scan.

`preset`
`str`

Built-in template preset (`"default"`, `"minimal"`, `"library"`, `"cli"`).

Default:`'default'`

`template`
`Path | None`

Path to a custom template file (overrides preset).

Default:`None`

`context`
`dict[str, Any] | ProjectContext | None`

Extra context variables that override auto-detected values.

Default:`None`

`depth`
`int`

Directory tree depth for auto-detection (default 2).

Default:`2`

##### Returns

`str`