make-release-readme

Automate README generation by running a script that scans your codebase to inventory features, orchestrates a Playwright screenshot campaign across desktop, tablet, and mobile viewports, and compiles a structured markdown document with installation and usage details.

The best way to create a release-ready README is to automate the process using a tool that reads your project features, captures embedded screenshots across multiple viewports, and compiles the text and images into a publishable markdown file.

Automated feature inventory works by scanning the codebase to identify app features, then passing that extracted list into the markdown generation process to populate the structured README with accurate project details and usage information.

Yes, the screenshot campaign supports mobile and tablet viewports by using Playwright to capture responsive screenshots of key routes, ensuring the generated README includes visuals for desktop, tablet, and mobile layouts.

Yes, you need a predictable project layout so the script can scan the codebase and identify key routes to screenshot, ensuring the Playwright campaign and markdown compilation produce a structured, release-ready document.

Limitations include relying on a predictable project layout to inventory features accurately, requiring Playwright to access web app routes, and depending on Python dependencies like pillow, typer, and loguru to compile the structured markdown file.