eli64s/readme-ai

README file generator, powered by AI.

What it solves

ReadmeAI is a developer tool that automates the creation and maintenance of README files. It eliminates the manual effort of writing documentation by automatically generating structured, detailed READMEs from a codebase, ensuring consistent best practices across projects regardless of the programming language or framework used.

How it works

The tool uses a repository processing engine to analyze a codebase provided via a URL (GitHub, GitLab, Bitbucket) or a local file system path. It then leverages advanced language models (LLMs) to generate the content. It is model-agnostic, supporting providers like OpenAI, Anthropic, Google Gemini, and Ollama, and even offers an offline mode for local operation without an API service.

Who it’s for

It is designed for developers of all technical disciplines and experience levels who want to streamline their documentation process and maintain professional, well-structured project overviews.

Highlights

  • Multi-LLM Support: Switch between OpenAI, Anthropic, Gemini, and Ollama.
  • Extensive Customization: Offers various header styles (classic, modern, compact, banner), badge styles, and custom logos.
  • Language Agnostic: Works with any codebase regardless of the language or framework.
  • Smart Filtering: Uses .readmeaiignore patterns to intelligently analyze files.
  • Comprehensive Content: Automatically generates project introductions, feature tables, directory structures, installation guides, and contribution guidelines.

Related

  • Project
    divar-ir/ai-doc-gen

    An AI-powered documentation generator that uses a multi-agent architecture to analyze codebases and automatically create READMEs and AI assistant configuration files.

  • Project
    FSoft-AI4Code/CodeWiki

    CodeWiki is an open‑source Python framework that uses LLMs (OpenAI, Anthropic, Azure, Bedrock, Atlas Cloud, or Claude/Codex subscription) to automatically generate comprehensive, architecture‑aware documentation—including markdown and Mermaid diagrams—for large, multi‑language codebases. It features hierarchical decomposition, recursive multi‑agent processing, configurable token limits, incremental updates, and GitHub‑Pages‑ready output.

  • Project
    devenjarvis/lathe

    A tool that uses LLMs to generate personalized, hands-on technical tutorials and provides a local UI for working through them manually to ensure the user actually learns the material.

  • Project
    srbhr/Resume-Matcher

    An AI-powered tool that tailors resumes and cover letters to specific job descriptions using LLMs to improve match scores and keyword alignment.

  • Project
    ConardLi/easy-dataset

    A tool for creating LLM fine-tuning datasets by converting unstructured documents into high-quality structured QA pairs and evaluation sets.