tldrs

You write code. tldrs writes your README.md.

13 followers

You write code. tldrs writes your README.md.

13 followers

tldrs is an AI-powered tool that generates clean, professional README.md files for your projects. Just cargo install it and run tldrs readme command, and get a well-structured README without writing a single line. Open-source and built for developers.

Free

Launch tags:Productivity•Open Source•GitHub

Launch Team

Framer — Launch websites with enterprise needs at startup speeds.

Launch websites with enterprise needs at startup speeds.

Promoted

Maker

📌

I was working on a side project last weekend and realized I had over 15 repos with either a single-line README or a novel no one reads. I kept spending more time documenting than building. So I built tldrs, a simple Rust CLI that uses AI to generate solid, readable README.md files from your codebase. It analyzes your structure, dependencies, and naming to figure out what your project does, then writes the docs for you.

Report

7mo ago

This is cool. I appreciate any application of AI that takes the tedium out of building, and writing and maintaining up-to-date README files is definitely in that category. ☺️

It looks like this works with Gemini and OpenAI models only - are you considering making this compatible with Ollama? That way users could run everything locally.

Report

7mo ago

Maker

@smjburton Yes, will be adding Ollama pretty soon

Report

7mo ago