README oluşturma

GitHub Kavramlarına Giriş

Jasmin Ludolf

Content Developer, DataCamp

README’yi düzenleme

README’yi düzenleme

README’yi düzenleme

Markdown

Düzenle vs. Önizleme

Başlıklar

Başlıklar

Başlıklar

Metin biçimlendirme

Köprüler

Köprüler

Görseller

README yazma

• Açıklayıcı olmalı
  • Herkes projeyi anlayabilmeli
• Depo içeriğini listeleyin
• Projeyi başkalarına netçe açıklar

README temel unsurları

• Başlık
• Teknoloji açıklaması
  • Neden?
• Sürecin açıklaması
  • Neden?
• İçindekiler

README ekleri

• Projenin nasıl ortaya çıktığı
• Motivasyon
• Sınırlamalar
• Zorluklar
• Çözmeyi amaçladığı sorun
• Hedeflenen kullanım
• Katkıda bulunanlar

Hadi pratik yapalım!

GitHub Kavramlarına Giriş