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.