readme ai

Projetado para simplicidade, personalização e produtividade do desenvolvedor.

Links rápidos

1. Visão geral

2. Demonstração

3. Características

4. Começando

5. Configuração

6. Exemplos

7. Contribuindo

Importante

Visite a documentação oficial para obter guias e tutoriais detalhados.

Visão geral

O ReadMe-AI é uma ferramenta de desenvolvedor que gera automaticamente os arquivos de readme de marcação usando um mecanismo de processamento de repositório robusto e modelos avançados de linguagem. Basta fornecer um URL ou caminho para sua base de código, e será gerada uma leitura bem estruturada e detalhada.

Por que readme-ai?

Esta ferramenta foi projetada para otimizar o processo de documentação para os desenvolvedores, economizando tempo e esforço, garantindo arquivos de leitura de alta qualidade. Os principais benefícios incluem:

• Potado a IA: alavancar modelos de linguagem para geração inteligente de conteúdo.

• Consistência: Garanta a documentação limpa e padronizada entre os projetos.

• Personalização: adapte a saída para atender aos requisitos do seu projeto.

• Idioma Agnóstico: funciona com a maioria das linguagens/estruturas de programação.

• Economize tempo: gerar leitura abrangente em menos de um minuto.

Demonstração

Correndo da linha de comando:

Readmeai-cli-Demo.mov

Correndo diretamente em seu navegador:

ReadmeAi-Streamlit-Demo.mov

---

Características

• Documentação automatizada: gerar arquivos de leitura abrangente automaticamente a partir da sua base de código.

• Saída personalizável: adapte o estilo, formatação, crachás, designs de cabeçalho e mais preferências.

• Backends flexíveis: integrar -se perfeitamente ao OpenAI , Ollama , Anthropic , Google Gemini .

• Idioma AGNOSTIC: Compatível com uma ampla gama de linguagens de programação e tipos de projeto.

• Modo offline: Crie arquivos de leitura de boilerplate offline, sem chamadas de API externas.

• Melhores práticas: garante documentação profissional limpa, aderindo às práticas recomendadas.

Vamos dar uma olhada em algumas possíveis personalizações criadas pelo ReadMe-AI:

Pip Método recomendado para a maioria dos usuários: ❯ Pip Install ReadMeii Pipx Use o PIPX para usar readmeai em um ambiente isolado, garantindo que nenhum conflito de dependência com outros projetos Python: ❯ PIPX Instale readmeai UV Use UV para a maneira mais rápida de instalar readmeai com um único comando: ❯ Ferramenta UV Instale ReadMeii Docker Para executar readmeai em um ambiente de contêiner, puxe a imagem mais recente do Docker do Docker Hub: ❯ Docker Pull Zeroxeli/ReadMe-AI: mais recente Da fonte Clique para expandir as instruções Clone o repositório: ❯ clone git https://github.com/eli64s/readme-ai Navegue até o diretório readme-ai : ❯ CD ReadMe-AI Instale dependências: ❯ Pip Install -R Setup/requisitos.txt Como alternativa, o projeto pode ser configurado usando o script Bash abaixo: Bash Execute o script de configuração: ❯ Bash Setup/Setup.sh Ou use poetry para construir o projeto: Poesia Instale dependências usando poesia: ❯ Instalação de poesia Importante Para usar os clientes antrópicos e do Google Gemini , são necessárias dependências extras. Instale o pacote com os seguintes extras: Antrópico: ❯ Pip Instale "ReadMeii [Anthrópio]" Google Gemini: ❯ Pip Install "ReadMeii [Google-Generativeai]" Instale vários clientes: ❯ Pip Install "ReadMeii [Anthropic, Google-Generativeai]" ? Executando a CLI 1. Configure variáveis ​​de ambiente Com o Openai: ❯ Exportar OpenAI_API_KEY = <HE YOUR_API_KEY># OU PARA USUÁRIOS DE Windows: ❯ Definir OpenAI_API_KEY = <HEAPI_KEY> Fornecedores adicionais (Ollama, Antrópico, Google Gemini) Ollama Consulte a documentação do Ollama para obter mais informações sobre como configurar a API Ollama. Aqui está um exemplo básico: Puxe seu modelo de escolha do Repositório Ollama: ❯ Ollama Pull Mistral: Último Inicie o servidor ollama e defina a variável de ambiente OLLAMA_HOST : ❯ Exportar ollama_host = 127.0.0.1 && ollama servir Antrópico Exportar sua chave de API antrópica: ❯ Exportar Anthrópico_API_KEY = <HEAPI_KEY> Google Gemini Exportar sua chave da API do Google Gemini: ❯ Export google_api_key = <your_api_key 2. Gere um readme Execute o seguinte comando, substituindo o URL do repositório por seu próprio: ❯ ReadMeii-Reepository https://github.com/eli64s/readme-ai --pi Openai Importante Por padrão, o modelo gpt-3.5-turbo é usado. Custos mais altos podem ser incorridos quando modelos mais avançados. Corra com Ollama e defina llama3 como o modelo: ❯ ReadMeii --pi ollama-Model llama3-Reprepository https://github.com/eli64s/readme-ai Corra com Anthropic : ❯ ReadMeii-API Anthropic -M Claude-3-5-Sonnet-20240620 -r https://github.com/eli64s/readme-ai Corra com Google Gemini : ❯ ReadMeii --pi Gemini -M Gemini-1.5-flash -r https://github.com/eli64s/readme-ai Use um caminho de diretório local : ReadMeii --Repository/Path/para/your/Project Adicione mais opções de personalização: ❯ ReadMeii-Reepository https://github.com/eli64s/readme-ai --output readmeai.md --API Openai -Modelo GPT-4 -Badge-cor A931EC -Quadro de badge quadrático -Compacto no estilo do cabeçalho -dobra no estilo-toc --temperatura 0,9 -De profundidade de árvore 2 --Image LLM --emojis Docker Execute o contêiner do Docker com o cliente Openai: ❯ Docker Run -it - -RM -e OpenAI_API_KEY = $ OpenAI_API_KEY -v "$ (pwd)":/app zeroxeli/readme-ai: mais recente --repository https://github.com/eli64s/readme-ai --API Openai Da fonte Clique para expandir as instruções Bash Se você instalou o projeto da fonte com o script Bash, execute o seguinte comando: Ative o ambiente virtual: ❯ CONDA Ative ReadMeii Execute a CLI: ❯ python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai Poesia Ative o ambiente virtual: ❯ Shell de poesia Execute a CLI: ❯ Poesia Run python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai Simplit Experimente o ReadMe-AI diretamente no seu navegador, não é necessária instalação. Consulte o repositório README-AI-Streamlit para obter mais detalhes. Teste As estruturas Pytest e NOx são usadas para desenvolvimento e teste. Instale as dependências usando poesia: ❯ Instalação de poesia -com dev, teste Execute o conjunto de testes de unidade usando o Pytest: ❯ Faça teste Execute a suíte de teste contra o Python 3.9, 3.10, 3.11 e 3.12 usando o NOX: ❯ Faça teste-nox Dica O NOX é uma ferramenta de automação que automatiza o teste em vários ambientes Python. É usado para garantir a compatibilidade em diferentes versões do Python. Configuração Personalize sua geração de leitura usando estas opções de CLI: Opção Descrição Padrão --align Alinhamento de texto no cabeçalho center --api Provedor de serviços de API LLM offline --badge-color Nome colorido de crachá ou código hexadecimal 0080ff --badge-style Tipo de estilo de ícone de crachá flat --header-style Estilo de modelo de cabeçalho classic --toc-style Estilo de mesa bullet --emojis Adiciona emojis às seções de cabeçalho ReadMe False --image Imagem do logotipo do projeto blue --model Modelo LLM específico para usar gpt-3.5-turbo --output Nome do arquivo de saída readme-ai.md --repository URL do repositório ou caminho de diretório local None --temperature Nível de criatividade para geração de conteúdo 0.1 --tree-depth Profundidade máxima da estrutura da árvore do diretório 2 Execute o seguinte comando para visualizar todas as opções disponíveis: ❯ ReadMeii -Help Visite a documentação oficial para obter informações mais detalhadas sobre opções de configuração, exemplos e práticas recomendadas. Exemplos Veja os arquivos de leitura de exemplo gerados pelo ReadMe-AI em várias pilhas de tecnologia: Tecnologia Exemplo de saída Repositório Descrição ReadMe-AI ReadMe-ai.md ReadMe-AI Projeto ReadMe-AI Apache Flink ReadMe-pyflink.md pyflink-poc Projeto Pyflink Simplit ReadMe-streamlit.md ReadMe-AI-Streamlit Aplicativo da Web simplit Vercel & NPM ReadMe-vercel.md Github-ReadMe-Quotes Implantação de vercel GO & DOCKER ReadMe-docker-go.md Docker-GS-Ping Dockerized Go App FASTAPI & REDIS ReadMe-Fastapi-Redis.md Inferência de ASYNC-ML Serviço de inferência assíncrona Java ReadMe-Java.md Minimal-Todo Aplicativo minimalista de TODO Java PostgreSql & DuckDB ReadMe-PostGres.md Buenavista PostGres Proxy Server Kotlin ReadMe-kotlin.md Android-Client Aplicativo do cliente Android Modo offline offline mode.md Litellm Serviço de API LLM Encontre exemplos adicionais de leitura no diretório exemplos. Roteiro Libere readmeai 1.0.0 com recursos aprimorados de gerenciamento de documentação. Desenvolva Vscode Extension para gerar arquivos ReadMe diretamente no editor. Desenvolva GitHub Actions para automatizar as atualizações de documentação. Adicione badge packs para fornecer estilos e opções adicionais de crachá. Cobertura de código, status de CI/CD, versão do projeto e muito mais. Contribuindo As contribuições são bem -vindas! Leia o guia contribuinte para começar. Guia contribuinte : Aprenda sobre nosso processo de contribuição e padrões de codificação. ? Relatar um problema : encontrou um bug? Deixe -nos saber! Comece uma discussão : tem idéias ou sugestões? Gostaríamos muito de ouvir de você. Agradecimentos Shields.io Ícones simples Aveek-Saha/Github-Profile-Badges ILERIAYO/REKDOWN-BADGES Tandpfun/Skill-icons Licença Copyright © 2023 ReadMe-AI. Liberado sob a licença do MIT.