ReadMeCreator With LLM

Criador de leitura usando LLM

Bem -vindo ao Criador Readme! Esta ferramenta simplifica o processo de geração de arquivos de leitura interativa.

Características

• Crie modelos de leitura rapidamente.
• Personalize modelos com prompts fáceis de usar.
• Gerar arquivos de leitura interativos e visualmente atraentes.

Começando

1. Clone este repositório:

git clone https://github.com/ashishpatel26/readme-creator-with-LLM.git
cd readme-creator

2. Instale as dependências necessárias:

pip install -r requirements.txt

3. Configure sua chave da API do OpenAI exportando -a como uma variável de ambiente:

 export OPEN_AI_KEY=your_openai_key_here

Uso

Execute o seguinte comando para iniciar o Criador ReadMe:

python src/readme_creator.py

Siga os avisos para personalizar seu modelo de leitura. A ferramenta gerará um arquivo readme.md interativo no diretório raiz.

Exemplos

Confira os examples/ diretório para modelos de leitura pré-projetados e sua saída correspondente.

Contribuindo

Congratulamo -nos com contribuições! Sinta -se à vontade para enviar solicitações de tração.

Licença

Este projeto está licenciado sob a licença do MIT - consulte o arquivo de licença para obter detalhes.