GitHub Nedir? Readme Nedir? GitHub ve Readme Nasıl kullanılır? Linus Torvalds Kimdir? Repository Nedir? GitHub Ne İşe Yarar? Readme Nasıl Kullanılır? Markdown Nedir? Proje Dosyası Nasıl Kullanılır? GitHub Proje Dosyasında Olması Gerekenler Nelerdir? GitHub Readme Nasıl Yazılır? GitHube Readme Örnekleri Nelerdir?
GitHub, proje yönetim ve versiyon kontrol sistemi olarak bilinmektedir. Ayrıca yazılımcılar ve geliştiriciler için yapılmış bir sosyal ağ aplikasyonudur.
GitHub hakkında yazmadan önce, GitHub’ın ana sistemi olan Git’i irdelemek gerekir. Git, Linus Torvalds tarafından geliştirilmiş bir versiyon kontrol sistemidir. Linus Torvalds ise Linux’u yaratan kişidir.
Peki öncelikle ‘’Versiyon Kontrol Sistemi’’ nedir öncelikle onu inceleyelim. Versiyon Kontrolü bazı kaynaklarda ‘’revizyon kontrolü’’ adıyla da geçmektedir. Bir veya birden fazla metin dosyası, görseller, medya dosyaları, çalıştırılabilir uygulamalar gibi dosyalar üzerinde yapılan değişikliklerin kaydedilmesi ve takip edilmesi gibi durumların kayıt altına alınması gibi özellikleri sağlayan bir sistemdir.
VCS, genellikle geliştiricilerin yazılım projelerinde kullanmış olduğu bir sistemdir. Ayrıca genellikle tasarım projelerinde kullanılan bir sistem olduğu aşikardır. Sağladığı bir diğer kolaylık ise, aynı dosya üzerinde çalışan birkaç geliştiriciler veya tasarımcılar grup halinde dosya üzerindeki açıkları ve hataları gerekli düzenlemelerle problemi ortadan kaldırabiliyorlar. Ardından iki farklı sürüm özelliği sayesinde iki farklı işlem tercihi mevcut.
İlk olarak ‘’Senkron’’ yönteminden bahsedecek olursak; birçok yazılımcı aynı sistem üzerinde beraber çalışırken sistem içinde bir dosya üzerinde değişiklik yapmak isteyen kullanıcının içinde olduğu dosyaya sistem kilit vurur ve dosyanın içinde olan kullanıcı dışında kimse dosya üzerinde bir değişiklik sağlayamaz. Bu özelliğin temel amacı, aynı dosya üzerinde yapılan eş zamanlı düzenlemelerin olmamasını sağlamak. Bahsetmem gereken ikinci işlem sistemi ise ‘’Asenkron’’ sistemdir. Bu sistemde adından da anlaşılacağı gibi kilit mekanizması kullanılmamaktadır. Bu da demek oluyor ki, aynı dosya üzerinde birden farklı kullanıcı düzenlemeler yapılır. Fakat asenkron sistemde dosya kilidi mekanizması devre dışında olduğu için eş zamanlı yapılan düzenlemeler sonucunda çakışmalar ortaya çıkabilmektedir, ve bu da süreci aksatabilmektedir.
Genel anlamda GitHub için bir tanım yapmamız gerekirse, GitHub özetle bir depolama (Repository) işletim sistemidir. GitHub hakkında özet mahiyetinde bir inceleme yaptığımıza göre gelelim asıl konumuza. GitHub tarafından yakın zamanda üretilen yeni bir dosya sistemi hakkındaki bilgileri irdeleyeceğiz. Bu sistemin adı ‘’Readme’’dir. Readme en basit tanımıyla, GitHub gibi veri depolama servislerinde bir proje oluşturduğunuzda projenizin açıklama kısmıdır. Bir kullanıcı projenizi incelediğinde projeye tıklandığında önüne gelen kısımdır. Tıklanan dosyanın açılış sayfasında görülen kısımdır. Peki Readme dosyanızın içinde neler olması gerektiğini sıralayalım:
*Projenizin genel bir özeti
*Projenizin nasıl indirileceği
*Projenizin nasıl çalıştırılacağı
*Proje içindeki testlerin nasıl çalıştırılacağı
*Proje geliştirilirken hangi teknolojilerden yararlandığınız
*Projeye eklemek istedikleriniz
*Projeye katkıda bulunanlar
*Lisans
Diyelim ki bir Readme dosyası oluşturdunuz. Bu dosyanızın uzantısı ‘’Readme.md’’ olabilir. Buradaki .md ‘’Markdown’’ anlamına gelir. Markdown bize düz yazı olarak adlandırdıklarımızı html’e dönüştürerek hızlı düzenlemeler yapmamızı sağlar. Çünkü html’de hızlı düzenlemeler yapmak zordur. Markdown için kaynak önerisinde bulunmak gerekirse; Online Editör kullanılabilir.
Son olarak güzel Readme kullanımlarını merak ediyorsanız. GitHub’ta bol yıldızlı depolara bakmanızı tavsiye ederim.
Ayrıca, bizi GitHub üzerinden takip edebilirsiniz; https://github.com/webodasi
Hata!
Yorumunuz Çok Kısa, Yorum yapabilmek için en az En az 10 karakter gerekli