README Generator

Documentation
that ships itself

Generate professional README files from your project metadata. Available as a web app, CLI tool, and VS Code extension.

Web ConfiguratorDocumentation
Next.js·React·TypeScript·Tailwind
PTKRDME Demo
Three Ways

Choose your interface

Web App

Drag-and-drop section configurator with live preview, project management, and team sharing.

Open Web App

CLI Tool

Generate from your terminal. Auto-detects dependencies, tech stack, and Git metadata.

npx ptkrdme init

VS Code Extension

Manage sections and generate READMEs from your editor sidebar with workspace-aware config.

Install Extension

Every section, configurable

Contributors
Contributors
Brands
Brands
License
License
Related Projects
Related Projects

Example Projects

Kotlin Quizapp

Kotlin Quizapp

A simple quiz app built with Kotlin and Jetpack Compose. It uses the PTK-RDME library to generate a README file from the app's metadata.

View Project
Marley Plant Dotfiles

Marley Plant Dotfiles

Linux Configuration Files and Custom Scripts for POP OS 12

View Project
House Of Games

House Of Games

CS22220 Group Project - Group 1 The Aim Of The Project is to create an online quiz game that follows the same rules as Richard Osmans House Of Games

View Project

Start generating

No signup required for the CLI. The web app needs an account to save configurations and share them with your team.

Open Web AppCLI