ReadmeAI is a Python-based CLI tool that automatically generates comprehensive README files for software projects using AI language models. It supports multiple LLM providers (OpenAI, Anthropic, Google Gemini, Ollama) and offers extensive customization options including header styles, badges, logos, and navigation layouts. The tool analyzes codebases from various platforms (GitHub, GitLab, Bitbucket, local files) and creates structured documentation with project overviews, feature tables, installation guides, and usage instructions. It includes an offline mode for generating READMEs without API calls and supports containerized deployment via Docker.

16m read timeFrom github.com
Post cover image
Table of contents
Quick LinksIntroductionDemoFeaturesGetting StartedConfigurationExample GalleryRoadmapContributingAcknowledgments🎗 License
2 Comments

Sort: