eli64s/readme-ai

README file generator, powered by AI.

What it solves

ReadmeAI 自动化了创建和维护项目文档的繁琐过程。它通过分析代码库，自动生成结构化、专业的 README，省去手动编写详细文档的时间和精力。

How it works

The tool uses a repository processing engine to analyze a codebase (provided via a URL or local path) and leverages advanced language models to generate the content. It is model-agnostic, supporting providers like OpenAI, Anthropic, Google Gemini, and Ollama, and even includes an offline mode for local operation without an API. The system extracts dependencies, system requirements, and project structure to populate various sections such as installation guides, usage instructions, and feature tables.

Who it’s for

所有技术领域和经验水平的开发者，都可以使用它来确保软件项目拥有干净、一致且高质量的文档，而无需花费数小时手动编写。

Highlights

  • Multi-Model Support: Compatible with OpenAI, Anthropic, Gemini, and Ollama.
  • Broad Compatibility: Works with a wide range of programming languages and frameworks across GitHub, GitLab, Bitbucket, and local file systems.
  • High Customizability: Offers various header styles (classic, modern, compact, banner), badge styles, and navigation options.
  • Intelligent Filtering: Uses .readmeaiignore patterns to filter files during analysis.
  • Comprehensive Content: Automatically generates project introductions, feature tables, directory structures, installation steps, and contribution guides.