ReadMeCreator With LLM

Pencipta readme menggunakan llm

Selamat datang di ReadMe Creator! Alat ini menyederhanakan proses menghasilkan file readme interaktif.

Fitur

• Buat template readme dengan cepat.
• Kustomisasi templat dengan prompt ramah pengguna.
• Hasilkan file readme interaktif dan menarik secara visual.

Memulai

1. Klon Repositori ini:

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

2. Instal dependensi yang diperlukan:

pip install -r requirements.txt

3. Siapkan Kunci API OpenAI Anda dengan mengekspornya sebagai variabel lingkungan:

 export OPEN_AI_KEY=your_openai_key_here

Penggunaan

Jalankan perintah berikut untuk memulai pencipta readme:

python src/readme_creator.py

Ikuti petunjuk untuk menyesuaikan template ReadMe Anda. Alat ini akan menghasilkan file readme.md interaktif di direktori root.

Contoh

Lihatlah examples/ direktori untuk templat readme yang telah dirancang sebelumnya dan output yang sesuai.

Berkontribusi

Kami menyambut kontribusi! Jangan ragu untuk mengirimkan permintaan tarik.

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT - lihat file lisensi untuk detailnya.