Standart Bir README Dosyası

Selamlar ve İyi Bayramlar arkadaşlar ,

Yarın Github’a bir proje yüklemeyi düşünüyorum ve bu benim ilk projem olacak . Bunun için sizden örnek bir README dosyası nasıl olmalı , neleri içermeli (Projeden projeye değişiklik gösterir illaki ) ,nelere dikkat etmeliyim gibi tavsiyeler almak istiyorum . Hatta sizin için de sakıncası yoksa size ait olan bir projenizin Github linkini de bırakabilirseniz incelemekten memnu kalırım .

Şimdiden teşekkürler .

burda icerik kismi var ordaki alt basliklari doldurursan yeterli olur

benim begendiklerimden youtube_dl in readme si

Teşekkürler bilgilendirme için .

Merhaba ve size de iyi bayramlar.

Github’da örnek bir README dosyası buldum, umarım işinize yarar.

1 Beğeni

Projeden genel olarak bahsedin. Markdown kesinlikle ogrenin ve kurallarina uyun. Ingilizce yazmaniz uygun olur. Reponun description kismi olabildigi kadar kisa oz olsun. Devami keyfinize bagli. Markdown’a dikkat ederek guide tarzi seyler yazabilirsiniz, projeden projeye degisir dediginiz gibi.

1 Beğeni

Yaramaz olur mu , çok teşekkürler .

Dediğinizi fark ettim bir kaç örnek inceledikten sonra , herkesin kendisine ve projenin içeriğine bağlı olarak farklı README dosyaları mevcut . Mrakdown’a da özellikle dikkat edicem . Teşekkür derim .