Github Readme Dosyası Oluşturma

Günümüzde en popüler sürüm kontrol sistemi olan Git ve Github takım çalışması ve bireysel çalışmalarda etkin bir şekilde kullanılmakta. Git ve Github kullanarak bir proje ekleyebilir takım olarak veya bireysel olarak takip ve kontrol edebilirsiniz. Github kullanarak kendi kodlarınızın ne kadar kaliteli olup olmadığını da ordaki eleştiriler ve tartışmalar doğrultusunda anlayabilir ve böylelikle kendinizi geliştirebilirsiniz.

Readme Nedir ?

Proje, dosya uygulama yada dijital ortamdaki her hangi bir yazılımla ilgili kullanımı, yükleme işlemini, projenin özetini,dosya dizin yolları gibi çeşitli konularda bilgi verilmesi amacıyla yazılan metinlerdir. Genelde (.txt), (.md) gibi uzantılara sahiptir. Daha belirgin olmasından dolayı genel de büyük harfle yazılır. 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. Markdown kullanımı ile ilgili Github’ın kendi açıklamarı: https://guides.github.com/features/mastering-markdown/ burda yer almaktadır.

Readme nasıl oluşturulur ?

Github hesabın da bulunan Repositories ( depolar) kısmına geliyoruz. New seçeneği ile bir proje oluşturacağız.

1 numaralı oluşturacağımız projenin ismi olacak. Readme yapmak istediğimiz için bu alana kendi kullanıcı adımızın aynısını yazıyoruz.

2 numaralı alan oluşturduğumuz projenin herkes tarafından görünürlüğünü kontrol ediyoruz. Biz burda (Public) yaparak herkes tarafından görünmesini sağlayacağız.

3 numaralı alan ise oluşturduğumuz projeye eklemek istediklerimizi seçiyoruz. Burda (README) seçerek readme.md dosyasını oluşturmuş olucaz.

4 numara ile oluştur işlemi ile tamamlıyoruz.

README.md dosyasını oluşturmuş olduk. Şimdi düzenleme işmeine geçiyoruz. Oklar ile gösterilen (Edit README) ile edit seçeneği ile düzenleme işlemine alıyoruz.

( https://arturssmirnovs.github.io/github-profile-readme-generator/ ) bu link ile erişim sağlayarak, readme dosyasını hızlı ve pratik bir şekilde oluşturuyoruz. Readme dosyasını pratik olarak oluşturmanın bir çok yolu var, ben size bana en kolay geleni sunmak istedim. Fotoğrafta görülen:

1 numaralı alan oluşturduğumuz en son aşamada gözükecek kısmı bize gösteriyor.
2. kısım ise kod kısmı en son oluşturduğumuz readme dosyasını kodlarını burdan alarak kendi readme klasörümüze atıcaz.
3. kısımda oluşturmak istediğimiz readme klasörünü istediğimiz hale getirmek için sunulan seçenekler mevcut.

Bu kısımda sizi kısaca özetlemeye yarayan seçenekler mevcut.

Bu kısımda Github üzerinden diğer sosyal medya ortamlarından size ulaşmasını istediğiniz kişiler için seçenek ekleyebilirsiniz.

Bu kısımda readme klasörünüze görsel açıdan şekil verebilir eklemeler yapabilirsiniz.

Tasarımı ve içeriğini bitirdiğimiz readme klasörünün kod kısmını koplayarak kendi readme klasörümüze yapıştırıyoruz.
Ardından (Commit changes) seçeneği ile işlmi tamamlıyoruz.

Ve artık bizi ve yaptığımız, yapmakta olduğumuz projeleri özetleyen sunan readme dosyası bitmiştir.

Kendi Github Readme dosyam : https://github.com/S-Oktay-Bicici/S-Oktay-Bicici