01 / THE WORKFLOW
From repository to readable README
Inspect repository files, generate a first draft, and edit Markdown alongside its rendered preview.
Web · local demo workspace Back to the vaultPROJECT / 02THE REASON UNDER THE HOOD
DEVELOPER TOOLSIN DEVELOPMENT
README Roulette
Good code deserves a better introduction.
Turn a GitHub repository into a clear README, architecture overview, setup guide, and portfolio description. All the context your code forgot to explain.
Source coming soon
THE REAL THING 01 / 04
The documentation landscape
Web · local demo workspaceAn overview of repository health and documentation gaps helps choose the next project to improve.
Swipe to explore
PLATFORMWeb
TECHNOLOGYNext.js / TypeScript / SQLite
DEVELOPMENTin development · v1.0.0
Why I built it.
Documentation is usually the last thing a project gets. A repository already contains the evidence for a useful first draft; the missing piece is turning it into something a human wants to read.
What’s inside
Repository-driven documentation
Architecture and setup overviews
Screenshot checklists and badge suggestions
Portfolio-ready project descriptions
Small pieces. Clear boundaries.
01
Interface
Next.js and React provide the repository and document workflow.
02
Documents
Markdown rendering and diff views support reviewing generated content.
03
Persistence
SQLite stores application data locally.
A CLOSER LOOK
A few moments inside README Roulette.
From the first screen to the details that make it useful.
02 / THE WORKFLOW
Review every change
A colored diff makes additions and removals visible before approving documentation changes.
Web · local demo workspace03 / THE WORKFLOW
Evidence behind the architecture
Explore the detected stack, scripts, dependencies, and environment requirements with source references.
Web · local demo workspaceON YOUR MACHINE
Take it for a spin.
Local development project. Provider and GitHub configuration may be required. A public release is not linked yet.
Source coming soon
From readme-roulette/
npm install
npm run dev