PTKRDME Generator

PTKRDME is a suite of tools for generating professional README documentation for software projects. It provides a consistent reading experience across projects by standardising the sections that appear in every README.

How it works

Each project has a .dev/rdme.config.json file in its root that declares which sections the README should include and their order. Sections are data-driven: they define typed fields (input, select,multi-select, repeater, shields) and render into markdown. Auto-detection scans the project's dependencies, tech stack, and Git metadata to pre-populate section data. All three tools share the same config file format, so teams can use whichever interface suits them.

Repositories

Tech Stack