This project provides an AI-powered tool for automatically generating and customizing README files for software projects. It targets developers seeking to streamline documentation creation, ensuring consistency and adherence to best practices across various languages and frameworks.

How It Works

ReadmeAI processes a given codebase (local or remote URL) using a robust engine to extract key information. It then leverages advanced language models (OpenAI, Anthropic, Gemini, Ollama, or offline mode) to generate structured content for sections like project introduction, features, structure, installation, and community guidelines. Customization is achieved through various command-line flags for headers, badges, logos, and navigation styles.

Quick Start & Requirements

• Install via pip: pip install -U readmeai
• Requires Python 3.9+
• Supports GitHub, GitLab, Bitbucket, and local file systems.
• LLM API keys (OpenAI, Anthropic, Gemini) or Ollama setup are needed for AI-powered generation.
• Official Documentation: https://readmeai.io/

Highlighted Details

• Supports multiple LLM providers including local Ollama models and an offline mode.
• Offers extensive customization for headers, badges, logos, and content sections.
• Generates a project structure tree and extracts dependencies for installation guides.
• Includes a Streamlit demo app for browser-based usage.

Maintenance & Community

• Active development with a roadmap including VS Code extension and GitHub Actions integration.
• Community contributions are encouraged via a contributing guide and discussion forums.
• Links: Contributing Guide, Report an Issue, Discussions.

Licensing & Compatibility

• Released under the MIT license.
• Permissive licensing allows for commercial use and integration with closed-source projects.

Limitations & Caveats

The Streamlit web app may not always reflect the latest CLI features. Users are advised to use the CLI for the most up-to-date functionality.