Github projelerini incelediğinizde çok güzel yazılmış readme dosyalarını görebilirsiniz. Bu yazımda nasıl readme dosyası yazılır onu anlatacağım.
Github'ta readme yazarken word standartlarını veya html standartlarını kullanamazsınız. Github'ın bunun için geliştirdiği kendi standartları vardır. Bu standartları kullanarak çok güzel readme dosyaları yazabilirsiniz. Github'ın bu konudaki resmi dökümanına aşağıdaki linkten ulaşabilirsiniz.
Şimdi bu standartları nasıl kullanacağınıza geçelim. Github projenizde bir readme dosyası ekledikten sonra aşağıdaki örnekleri kullanarak bir readme yazabilirsiniz.
Başlık Eklemek
# The largest heading
## The second largest heading
###### The smallest heading
Yazı Standartları
Sol taraftaki gibi yazdığımızda, sağ taraftaki gibi bir çıktı alabiliyoruz.
Alıntı Yapmak
In the words of Abraham Lincoln:
> Pardon my French
Consol Komutu Eklemek
Some basic Git commands are:
```
git status
git add
git commit
```
Link Eklemek
This site was built using [GitHub Pages](https://pages.github.com/).
Liste Eklemek
- George Washington
- John Adams
- Thomas Jefferson
1. James Madison
2. James Monroe
3. John Quincy Adams
Emoji Eklemek
@octocat :+1: This PR looks great - it's ready to merge! :shipit:
Kullanabileceğiniz emoji listesine buradan ulaşabilirsiniz.
Resim Eklemek
Kod Eklemek
```javascript
if (isAwesome){
return true
}
```
teşekkürler
ReplyDelete