readme ai

Diseñado para la simplicidad, personalización y productividad del desarrollador.

Enlaces rápidos

1. Descripción general

2. Manifestación

3. Características

4. Empezando

5. Configuración

6. Ejemplos

7. Que contribuye

Importante

Visite la documentación oficial para obtener guías y tutoriales detallados.

Descripción general

ReadMe-AI es una herramienta de desarrollador que genera automáticamente archivos de markdown ReadMe utilizando un motor de procesamiento de repositorio robusto y modelos de lenguaje avanzado. Simplemente proporcione una URL o ruta a su base de código, y se generará un readMe bien estructurado y detallado.

¿Por qué ReadMe-Ai?

Esta herramienta está diseñada para optimizar el proceso de documentación para los desarrolladores, ahorrando tiempo y esfuerzo al tiempo que garantiza archivos ReadMe de alta calidad. Los beneficios clave incluyen:

• AI: Avance modelos de lenguaje para la generación de contenido inteligente.

• Consistencia: garantizar la documentación limpia y estandarizada en todos los proyectos.

• Personalización: adapte la salida para que se ajuste a los requisitos de su proyecto.

• Lenguaje Agnóstico: funciona con la mayoría de los lenguajes/marcos de programación.

• Ahorre tiempo: genere lecturas integrales en menos de un minuto.

Manifestación

Corriendo desde la línea de comando:

readmeai-cli-demo.mov

Corriendo directamente en su navegador:

readmeai-streamlit-demo.mov

---

Características

• Documentación automatizada: genere archivos ReadMe completos automáticamente desde su base de código.

• Salida personalizable: Adapte el estilo, el formato, las insignias, los diseños de encabezados y más preferencias.

• Backends flexibles: integrarse sin problemas con OpenAI , Ollama , Anthropic , Google Gemini .

• Lenguaje Agnóstico: compatible con una amplia gama de lenguajes de programación y tipos de proyectos.

• Modo fuera de línea: cree archivos README Boilerplate fuera de línea, sin ninguna llamada de API externa.

• Las mejores prácticas: garantiza la documentación limpia y profesional, adherida a las mejores prácticas de Markdown.

Echemos un vistazo a algunas posibles personalizaciones creadas por ReadMe-AI:

Pepita Método recomendado para la mayoría de los usuarios: ❯ PIP Instale ReadMeai Pipa Use PIPX para usar readmeai en un entorno aislado, asegurando que no hay conflictos de dependencia con otros proyectos de Python: ❯ Pipx Instale ReadMeai Uva Use UV para la forma más rápida de instalar readmeai con un solo comando: ❯ UV Tool Instalar ReadMeai Estibador Para ejecutar readmeai en un entorno contenedorizado, extraiga la última imagen de Docker de Docker Hub: ❯ Docker Pull Zeroxeli/ReadMe-AI: Último De la fuente Haga clic para expandir las instrucciones Clon el repositorio: ❯ clon git https://github.com/eli64s/readme-ai Navegue al directorio readme-ai : ❯ CD ReadMe-AI Instalar dependencias: ❯ PIP Install -R Configuración/requisitos.txt Alternativamente, el proyecto se puede configurar utilizando el script bash a continuación: Intento Ejecute el script de configuración: ❯ bash setup/setup.sh O use poetry para construir el proyecto: Poesía Instalar dependencias usando poesía: ❯ Instalación de poesía Importante Para usar los clientes antrópicos y Google Gemini , se requieren dependencias adicionales. Instale el paquete con los siguientes extras: Antrópico: ❯ PIP Instale "ReadMeai [antrópico]" Google Géminis: ❯ Instale PIP "ReadMeai [Google-Generativeai]" Instalar múltiples clientes: ❯ Instale PIP "ReadMeai [antrópico, Google-Generativeai]" ? Ejecutando el CLI 1. Configurar variables de entorno Con OpenAi: ❯ Exportar Operai_api_key = <Your_api_Key># o para usuarios de Windows: ❯ Establezca Operai_api_Key = <Your_api_Key> Proveedores adicionales (Ollama, Anthrope, Google Gemini) Ollama Consulte la documentación de Ollama para obtener más información sobre cómo configurar la API Ollama. Aquí hay un ejemplo básico: Tire de su modelo de elección del repositorio Ollama: ❯ Ollama Pull Mistral: Último Inicie el servidor Ollama y establezca la variable de entorno OLLAMA_HOST : ❯ Exportar ollama_host = 127.0.0.1 && ollama servir Antrópico Exporte su clave API antrópica: ❯ Exportar Anthrope_api_key = <Your_api_Key> Google Géminis Exporte su clave de API de Google Gemini: ❯ Exportar Google_api_key = <Your_api_Key 2. Generar un readme Ejecute el siguiente comando, reemplazando la URL del repositorio con la suya: ❯ READMEAI-Repository https://github.com/eli64s/readme-ai --api Openai Importante Por defecto, se utiliza el modelo gpt-3.5-turbo . Se pueden incurrir en costos más altos cuando los modelos más avanzados. Ejecutar con Ollama y establecer llama3 como modelo: ❯ ReadMeai --api Ollama --Model Llama3 ---Repository https://github.com/eli64s/readme-ai Correr con Anthropic : ❯ ReadMeai --api Anthrope -M Claude-3-5-Sonnet-20240620 -R https://github.com/eli64s/readme-ai Ejecute con Google Gemini : ❯ ReadMeai --api Gemini -M Gemini-1.5-flash -r https://github.com/eli64s/readme-ai Use una ruta de directorio local : ReadMeai -Repository/Path/To/Your/Project Agregue más opciones de personalización: ❯ ReadMeai-Repository https://github.com/eli64s/readme-ai --output readMeai.md -API OpenAi -Modelo GPT-4 --Badge-Color A931EC -Badge Style Flat-cuadrado -compacto de estilo header -Doble de estilo-toc --Temperatura 0.9 --Tree-DePth 2 --image llm -emojis Estibador Ejecute el contenedor Docker con el cliente Operai: ❯ Docker Run -it - -Rm -e OpenAI_API_KEY = $ OPERAI_API_KEY -v "$ (pwd)":/app zeroxeli/readme-ai: Último -Repository https://github.com/eli64s/readme-ai -API OpenAi De la fuente Haga clic para expandir las instrucciones Intento Si instaló el proyecto desde la fuente con el script bash, ejecute el siguiente comando: Active el entorno virtual: ❯ CondA Active ReadMeai Ejecute el CLI: ❯ python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai Poesía Active el entorno virtual: ❯ Concha de poesía Ejecute el CLI: ❯ Poetry Run Python3 -M ReadMeai.cli.main -r https://github.com/eli64s/readme-ai Racionalizar Pruebe ReadMe-AI directamente en su navegador, no se requiere instalación. Vea el repositorio ReadMe-AI-Streamlit para obtener más detalles. Pruebas Los marcos Pytest y NOx se utilizan para el desarrollo y las pruebas. Instale las dependencias usando poesía: ❯ Instalación de poesía -con desarrollo, prueba Ejecute la suite de prueba unitaria con Pytest: ❯ Haga la prueba Ejecute la suite de prueba contra Python 3.9, 3.10, 3.11 y 3.12 usando NOX: ❯ Hacer test-nox Consejo Nox es una herramienta de automatización que automatiza las pruebas en múltiples entornos de Python. Se utiliza para garantizar la compatibilidad en diferentes versiones de Python. Configuración Personalice su generación ReadMe utilizando estas opciones de CLI: Opción Descripción Por defecto --align Alineación de texto en el encabezado center --api Proveedor de servicios de API LLM offline --badge-color Nombre de color de insignia o código hexadecimal 0080ff --badge-style Tipo de estilo de icono de insignia flat --header-style Estilo de plantilla de encabezado classic --toc-style Tabla de contenido estilo bullet --emojis Agrega emojis a las secciones de encabezado Readme False --image Imagen del logotipo del proyecto blue --model Modelo de LLM específico para usar gpt-3.5-turbo --output Nombre de archivo de salida readme-ai.md --repository URL de repositorio o ruta de directorio local None --temperature Nivel de creatividad para la generación de contenido 0.1 --tree-depth Profundidad máxima de la estructura del árbol del directorio 2 Ejecute el siguiente comando para ver todas las opciones disponibles: ❯ Readmeai --help Visite la documentación oficial para obtener información más detallada sobre opciones de configuración, ejemplos y mejores prácticas. Ejemplos Ver ejemplo de archivos ReadMe generados por ReadMe-AI en varias pilas de tecnología: Tecnología Salida de ejemplo Repositorio Descripción Readme-ai readme-ai.md readme-ai Proyecto ReadMe-AI Apache flink readme-pyflink.md pyflink-poc Proyecto Pyflink Racionalizar readMe-streamlit.md readme-ai-streamlit Aplicación web a fuego lento VERCE y NPM readme-vercel.md github-readme-cotes Despliegue de VERCEL Go & Docker readme-docker-go.md Docker-GS-Ping Aplicación Dockerized Go Fastapi y Redis readMe-Fastapi-Redis.md async-ml-inferencia Servicio de inferencia de async ml Java readme-java.md Mínimo Aplicación minimalista de java PostgreSQL y Duckdb readme-postgres.md Buenavista Servidor proxy de postgrres Kotlín readme-kotlin.md ydroid-cliente Aplicación del cliente de Android Modo fuera de línea sin conexión-mode.md litellm Servicio de API de LLM Encuentre ejemplos de lectura adicionales en el directorio de ejemplos. Hoja de ruta Release readmeai 1.0.0 con funciones de gestión de documentación mejoradas. Desarrolle Vscode Extension para generar archivos ReadMe directamente en el editor. Desarrolle GitHub Actions para automatizar las actualizaciones de documentación. Agregue badge packs para proporcionar estilos y opciones adicionales de insignia. Cobertura de código, estado de CI/CD, versión del proyecto y más. Que contribuye ¡Las contribuciones son bienvenidas! Lea la guía contribuyente para comenzar. Guía contribuyente : aprenda sobre nuestro proceso de contribución y estándares de codificación. ? Informar un problema : ¿encontró un error? ¡Háganos saber! Iniciar una discusión : ¿Tiene ideas o sugerencias? Nos encantaría saber de ti. Expresiones de gratitud Shields.io Iconos simples Aveek-Saha/Github-Profile-Badges Ileriayo/markdown-badges tandpfun/habilidad-icons Licencia Copyright © 2023 ReadMe-AI. Liberado bajo la licencia MIT.