README oluşturma

GitHub Kavramlarına Giriş

Jasmin Ludolf

Content Developer, DataCamp

README’yi düzenleme

Futbol analizi deposu görünümü

GitHub Kavramlarına Giriş

README’yi düzenleme

README dosyası vurgulanmış futbol analizi deposu görünümü

GitHub Kavramlarına Giriş

README’yi düzenleme

README dosyasını düzenlemek için kalem simgesi vurgulanmış futbol analizi deposu görünümü

GitHub Kavramlarına Giriş

Markdown

README dosyası görünümü

GitHub Kavramlarına Giriş

Düzenle vs. Önizleme

Düzenleme ve önizleme sekmeleri vurgulanmış README dosyası görünümü

GitHub Kavramlarına Giriş

Başlıklar

En büyük başlık için sözdizimini gösteren bir markdown dosyası düzenleme görünümü

En büyük başlığa sahip bir markdown dosyası önizleme görünümü

GitHub Kavramlarına Giriş

Başlıklar

Altı başlık türünün sözdizimini gösteren bir markdown dosyası düzenleme görünümü

Altı başlık türünün tümünü içeren bir markdown dosyası önizleme görünümü

GitHub Kavramlarına Giriş

Başlıklar

Altı başlık türünün sözdizimini gösteren bir markdown dosyası düzenleme görünümü]

Altı başlık türünü içeren bir markdown dosyası önizleme görünümü ve birinci ve ikinci başlık altındaki çizgileri gösteren oklar

GitHub Kavramlarına Giriş

Metin biçimlendirme

Kalın ve italik için sözdizimini gösteren bir markdown dosyası düzenleme görünümü

Kalın ve italik metin içeren bir markdown dosyası önizleme görünümü

GitHub Kavramlarına Giriş

Köprüler

Köprü için sözdizimini gösteren bir markdown dosyası düzenleme görünümü

Bir köprü içeren bir markdown dosyası önizleme görünümü

GitHub Kavramlarına Giriş

Köprüler

Bir köprüye tıklamanın animasyonlu görünümü

GitHub Kavramlarına Giriş

Görseller

Bir görseli markdown dosyasına sürüklemenin ve GitHub’ın sözdizimini otomatik oluşturmasının animasyonlu görünümü

GitHub Kavramlarına Giriş

README yazma

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

Açık bir kitabın illüstrasyonu

GitHub Kavramlarına Giriş

README temel unsurları

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

README ekleri

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

Hadi pratik yapalım!

GitHub Kavramlarına Giriş

Preparing Video For Download...