Profesyonel README.md
Projeni tanıt, herkesin katkı yapabilmesini sağla.
👔 Yazılım Geliştirici
#dokümantasyon
📊 Orta
🛠 GitHub Copilot
✓ Ücretsiz
💬 Prompt
Aşağıdaki GitHub projesi için profesyonel README.md yaz: Proje: [PROJE ADI] Ne işe yarar: [1 CÜMLE] Ana özellikler: [3-5 MADDE] Stack: [DİL/FRAMEWORK] Hedef kullanıcı: [DEVELOPER / SON KULLANICI] Lisans: [MIT/GPL/...] README bölümleri: 1. Logo/banner placeholder + Project title 2. Badges (build, version, license, download) 3. 1 cümlelik açıklama + ekran görüntüsü yeri 4. Table of contents 5. Özellikler (checkmark'lı liste) 6. Hızlı başlangıç (3 komut) 7. Kurulum (detaylı, OS bazlı) 8. Kullanım örnekleri (en az 3) 9. Konfigürasyon / ortam değişkenleri 10. API dokumanı linki veya özet 11. Testler nasıl çalıştırılır 12. Contributing rehberi (issue'dan PR'a) 13. Roadmap / bilinen sorunlar 14. Teşekkür / kontrbütörler 15. Lisans Pragmatik, okuyanın 2 dakikada projeyi anlaması için optimize et.
📝 Örnek Çıktı
README 8 bölüm, 2 kod örneği, 4 badge ile çıktı. Projeye star sayısı 2 haftada 3 kat arttı.
🎯 Nasıl Kullanılır?
- Yukarıdaki 📋 Kopyala butonuna bas
- Köşeli parantez içindeki
[alanları]kendi bilgilerinle değiştir - GitHub Copilot'a yapıştır, gönder
- Çıkan sonucu ihtiyacına göre ince ayarla
3
Görüntülenme
0
Kopyalama