ReadMeCreator With LLM

ผู้สร้าง readme โดยใช้ LLM

ยินดีต้อนรับสู่ผู้สร้าง readme! เครื่องมือนี้ทำให้กระบวนการสร้างไฟล์ 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. ตั้งค่าคีย์ OpenAI API ของคุณโดยส่งออกเป็นตัวแปรสภาพแวดล้อม:

 export OPEN_AI_KEY=your_openai_key_here

การใช้งาน

เรียกใช้คำสั่งต่อไปนี้เพื่อเริ่มผู้สร้าง ReadMe:

python src/readme_creator.py

ทำตามพรอมต์เพื่อปรับแต่งเทมเพลต readme ของคุณ เครื่องมือจะสร้างไฟล์ readme.md แบบโต้ตอบในไดเรกทอรีรูท

ตัวอย่าง

ตรวจสอบ examples/ ไดเรกทอรีสำหรับเทมเพลต ReadMe ที่ออกแบบไว้ล่วงหน้าและเอาต์พุตที่สอดคล้องกัน

การบริจาค

เรายินดีต้อนรับผลงาน! อย่าลังเลที่จะส่งคำขอดึง

ใบอนุญาต

โครงการนี้ได้รับใบอนุญาตภายใต้ใบอนุญาต MIT - ดูไฟล์ใบอนุญาตสำหรับรายละเอียด