ReadMeCreator With LLM

Readme Creator usando LLM

¡Bienvenido al Readme Creator! Esta herramienta simplifica el proceso de generar archivos README interactivos.

Características

• Cree rápidamente plantillas README.
• Personalizar plantillas con indicaciones fáciles de usar.
• Genere archivos ReadMe interactivos y visualmente atractivos.

Empezando

1. Clon este repositorio:

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

2. Instale las dependencias requeridas:

pip install -r requirements.txt

3. Configure su tecla API OpenAI exportándola como una variable de entorno:

 export OPEN_AI_KEY=your_openai_key_here

Uso

Ejecute el siguiente comando para iniciar el ReadMe Creator:

python src/readme_creator.py

Siga las indicaciones para personalizar su plantilla ReadMe. La herramienta generará un archivo Interactive ReadMe.md en el directorio raíz.

Ejemplos

Consulte los examples/ directorio para ver las plantillas ReadMe prediseñadas y su salida correspondiente.

Que contribuye

¡Agradecemos las contribuciones! No dude en enviar solicitudes de extracción.

Licencia

Este proyecto tiene licencia bajo la licencia MIT; consulte el archivo de licencia para obtener más detalles.