ReadMeCreator With LLM

Readme Creator с использованием LLM

Добро пожаловать в Creatme Creator! Этот инструмент упрощает процесс генерации интерактивных файлов Readme.

Функции

• Быстро создайте шаблоны Readme.
• Настройте шаблоны с удобными подсказками.
• Создать интерактивные и визуально привлекательные файлы README.

Начиная

1. Клонировать это хранилище:

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

2. Установите требуемые зависимости:

pip install -r requirements.txt

3. Установите свой ключ API OpenAI, экспортируя его как переменную среды:

 export OPEN_AI_KEY=your_openai_key_here

Использование

Запустите следующую команду, чтобы запустить Creatme Creator:

python src/readme_creator.py

Следуйте подсказкам, чтобы настроить свой шаблон Readme. Инструмент будет генерировать интерактивный файл readme.md в корневом каталоге.

Примеры

Проверьте examples/ каталог для предварительно разработанных шаблонов Readme и их соответствующего вывода.

Внося

Мы приветствуем вклад! Не стесняйтесь отправлять запросы на привлечение.

Лицензия

Этот проект лицензирован по лицензии MIT - для получения подробной информации см. Файл лицензии.