GitHub projelerinin README dosyası, bir projenin ilk izlenimini oluşturur. Yeni kullanıcılar ve potansiyel katkıda bulunanlar için projenizin ne yaptığını, nasıl kullanılacağını ve projeye nasıl katkıda bulunulacağını anlamak için başvurdukları ilk yerdir. İyi bir README, projeye olan ilgiyi artırabilir ve daha fazla katkıda bulunulmasını teşvik edebilir.
Readme oluşturmak için reponuzda Add a README butonuna tıklayarak başlayabilirsiniz. README belgesini HTML yada Markdown dilini kullanarak oluşturabilirsiniz.
Markdown ve HTML Kodlaması
Öncelikle Markdown ve HTML ile nasıl yazacağını bilmelisiniz.
Markdown ile Başlık Oluşturma:
Markdown ile başlık oluşturmak için # sembolü kullanılır. Her # sembolü bir başlık seviyesini belirtir, daha fazla # daha düşük bir seviyede başlık oluşturur.
|
1 2 3 4 5 6 7 8 |
# Başlık 1 ## Başlık 2 ### Başlık 3 #### Başlık 4 ##### Başlık 5 ###### Başlık 6 |
HTML ile Başlık Oluşturma:
HTML ile başlık oluşturmak için <h1>, <h2>, <h3>, <h4>, <h5>, <h6> etiketleri kullanılır.
|
1 2 3 4 5 6 7 8 |
<h1>Başlık 1</h1> <h2>Başlık 2</h2> <h3>Başlık 3</h3> <h4>Başlık 4</h4> <h5>Başlık 5</h5> <h6>Başlık 6</h6> |
Markdown ile Kalın, İtalik:
|
1 2 3 4 |
**Kalın** yazı için çift yıldız kullanılır. *İtalik* yazı için tek yıldız kullanılır. |
HTML ile Kalın, İtalik:
|
1 2 3 4 |
<strong>Kalın</strong> yazı için <strong>etiket</strong> kullanılır. <em>İtalik</em> yazı için <em>etiket</em> kullanılır. |
Markdown ile Çizgi Oluşturma:
Markdown ile çizgi oluşturmak için üç veya daha fazla - veya * sembolü kullanabilirsiniz.
|
1 2 3 4 5 6 7 8 9 |
# Barınak Uygulama V2.0.1 **Kalın** yazı için çift yıldız (`**`) kullanılır. *İtalik* yazı için tek yıldız (`*`) veya alt çizgi (`_`) kullanılır. --- |
HTML ile Çizgi Oluşturma:
HTML ile çizgi oluşturmak için <hr> etiketini kullanabilirsiniz.
|
1 2 3 4 5 6 |
<h1>Barınak Uygulama V2.0.1</h1> <strong>Kalın</strong> yazı için <strong>etiket</strong> kullanılır. <em>İtalik</em> yazı için <em>etiket</em> kullanılır. <hr> |
Numaralandırılmış Liste:
|
1 2 3 4 5 |
1. İlk öğe 2. İkinci öğe 3. Üçüncü öğe |
Madde İşaretli Liste:
|
1 2 3 4 5 |
- Birinci madde - İkinci madde - Üçüncü madde |
Markdown ile Kod Ekleme:
Kod bloklarını üç ters () işareti veya üç tırnak işaretiyle ( ) başlatıp bitirerek oluşturabilirsiniz. İçindeki kodun dilini belirtmek isterseniz, kod bloğunun başlangıcına dil adını ekleyebilirsiniz.
Ters tırnak işaretini çıkarmak için ALT GR + ; tuşlarına iki sefer basın.
|
1 2 3 4 5 6 7 8 9 10 |
## Örnek Kod Aşağıdaki python kodu bir örnektir. ```python def hello_world(): print("Hello, world!") ``` ## Diğer Talimatlar Diğer açıklamalar ile devam ediyor. |
HTML ile Kod Ekleme:
HTML’de <code> etiketi kullanarak tek bir satır kod ekleyebilirsiniz. Birden fazla satır kod için <pre> etiketi kullanabilirsiniz.
|
1 2 3 4 5 6 7 8 9 |
<h2>Örnek Kod</h2> <p>Aşağıdaki python kodu bir örnektir.</p> <pre><code class="language-python">def hello_world(): print("Hello, world!") </code></pre> <h2>Diğer Talimatlar</h2> <p>Diğer açıklamalar ile devam ediyor.</p> |
Markdown ile Bağlantı Oluşturma:
|
1 2 3 |
[Metin](URL) kullanarak bir bağlantı oluşturabilirsiniz. |
HTML ile Bağlantı Oluşturma:
|
1 2 3 |
<a href="URL">Metin</a> kullanarak bir bağlantı oluşturabilirsiniz. |
Markdown ile Resim Ekleme:
|
1 2 3 |
 kullanarak bir resim ekleyebilirsiniz. |
HTML ile Resim Ekleme:
|
1 2 3 |
<img src="URL" alt="Alternatif Metin"> kullanarak bir resim ekleyebilirsiniz. |
Markdown ile YouTube Videosu Ekleme:
YouTube videosunu eklemek için normal Markdown bağlantı kullanabilirsiniz.
|
1 2 3 |
[](Video URL) |
Tablo Oluşturma:
Markdown’da tablo oluşturmak için dikey çubuklar | ve tireler - kullanılır.
|
1 2 3 4 5 6 |
| Başlık 1 | Başlık 2 | |----------|----------| | Hücre 1 | Hücre 2 | | Hücre 3 | Hücre 4 | |
HTML ile tablo oluşturmak daha ayrıntılıdır:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
<table> <tr> <th>Başlık 1</th> <th>Başlık 2</th> </tr> <tr> <td>Hücre 1</td> <td>Hücre 2</td> </tr> <tr> <td>Hücre 3</td> <td>Hücre 4</td> </tr> </table> |
Bu örnekler, README dosyanızda çeşitli öğeleri nasıl oluşturacağınızı göstermek için kullanılabilir.
Detaylı Açıklama Ekleme:
Markdown’da başlık olarak eklenen katlanabilir bölüm için şu adımları izleyebiliriz:
<details>ve<summary>etiketleri kullanarak katlanabilir bölümü oluşturun.<summary>etiketi içine başlık yazın.- İçerik kısmını
<details>ve</details>etiketleri arasına yazın.
İşte bu adımları bir örnekle gösterelim:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
<details> <summary>Detaylı Açıklama</summary> Bu bölüm, detaylı açıklamaları içerir. Örneğin: - İlk detay - İkinci detay - Üçüncü detay </details> |
Bu Markdown kodu, “Detaylı Açıklama” başlığının altında bir açılır menü oluşturur. Bu menüyü tıklayarak detayları açabilir veya kapatabilirsiniz. Bu şekilde, README dosyanızda uzun veya detaylı içeriği kullanıcıların isteğine göre gizlemek veya göstermek için kullanabilirsiniz.
Alıntı:
|
1 2 3 |
> Bu bir alıntıdır. |
MarkDown Stilleri
Markdown’da metni vurgulamak için kullanılabilecek çeşitli stiller vardır. İşte bazı örnekler:
- Kalın: Kalın metin için
** **veya__ __kullanın. - İtalik: İtalik metin için
* *veya_ _kullanın. Üstü çizili: Üstü çizili metin için~~ ~~kullanın.- Kalın ve iç içe geçmiş italik:
** **ve_ _kullanarak kalın ve iç içe geçmiş italik metin oluşturabilirsiniz. - Tümü kalın ve italik:
*** ***kullanarak tüm metni hem kalın hem de italik yapabilirsiniz. - Alt yazı:
<sub> </sub>etiketlerini kullanarak alt yazı oluşturabilirsiniz. - Üst simge:
<sup> </sup>etiketlerini kullanarak üst simge oluşturabilirsiniz.
Bu Markdown kodlarını kullanarak metninizi çeşitli şekillerde vurgulayabilirsiniz. Örneğin:
|
1 2 3 4 5 6 7 8 9 |
**Kalın** metin için çift yıldız kullanın. *İtalik* metin için tek yıldız kullanın. ~~Üstü çizili~~ metin için tilda kullanın. **Kalın ve _iç içe geçmiş italik_** metin için uygun semboller kullanın. ***Tümü kalın ve italik*** metin için üç yıldız kullanın. Bu bir <sub>alt yazı</sub> örneğidir. Bu bir <sup>üst simge</sup> örneğidir. |
Kod Alıntılama
Bir cümle içinde kod veya bir komut belirtmek için tek ters tırnak (`) kullanabilirsiniz. Ters tırnak içindeki metin biçimlendirilmeyecektir. Ayrıca, bir Markdown satırında bir kod bloğu için ters tırnak eklemek için, Command+E (Mac) veya Ctrl+E (Windows/Linux) klavye kısayolunu kullanabilirsiniz.
|
1 2 3 |
`git status` komutunu kullanarak henüz taahhüt edilmemiş tüm yeni veya değiştirilmiş dosyaları listeleyebilirsiniz. |
Göreceli Bağlantılar
Okuyucuların depodaki diğer dosyalara geçiş yapmasına yardımcı olmak için oluşturulan dosyalarda göreceli bağlantılar ve görüntü yolları tanımlayabilirsiniz.
Bir göreceli bağlantı, mevcut dosyaya göre göreli olan bir bağlantıdır. Örneğin, depo kökünde bir README dosyanız varsa ve docs/CONTRIBUTING.md adında başka bir dosyanız varsa, README’deki CONTRIBUTING.md’ye göreceli bağlantı şöyle görünebilir:
GitHub, göreceli bağlantınızı veya görüntü yolunuzu otomatik olarak, mevcut olduğunuz dal temel alarak dönüştürecektir, böylece bağlantı veya yol her zaman çalışır durumda olacaktır. Bağlantının yolu, mevcut dosyaya göre göreli olacaktır. / ile başlayan bağlantılar, depo köküne göre göreceli olacaktır. ./ ve ../ gibi tüm göreceli bağlantı operatörlerini kullanabilirsiniz.
Göreceli bağlantılar, depoyu klonlayan kullanıcılar için daha kolaydır. Mutlak bağlantılar, depoyu klonlarınca çalışmayabilir – bu nedenle, depo içindeki diğer dosyalara referans vermek için göreceli bağlantıları kullanmanızı öneririz.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
## Göreceli Bağlantılar Okuyucuların depodaki diğer dosyalara geçiş yapmasına yardımcı olmak için oluşturulan dosyalarda göreceli bağlantılar ve görüntü yolları tanımlayabilirsiniz. Bir göreceli bağlantı, mevcut dosyaya göre göreli olan bir bağlantıdır. Örneğin, depo kökünde bir README dosyanız varsa ve `docs/CONTRIBUTING.md` adında başka bir dosyanız varsa, README'deki CONTRIBUTING.md'ye göreceli bağlantı şöyle görünebilir: [Proje için katkı kuralları](docs/CONTRIBUTING.md) GitHub, göreceli bağlantınızı veya görüntü yolunuzu otomatik olarak, mevcut olduğunuz dal temel alarak dönüştürecektir, böylece bağlantı veya yol her zaman çalışır durumda olacaktır. Bağlantının yolu, mevcut dosyaya göre göreli olacaktır. `/` ile başlayan bağlantılar, depo köküne göre göreceli olacaktır. `./` ve `../` gibi tüm göreceli bağlantı operatörlerini kullanabilirsiniz. Bağlantı metninizi tek bir satırda olmalıdır. Aşağıdaki örnek işe yaramayacaktır. [Proje için katkı kuralları](docs/CONTRIBUTING.md) Göreceli bağlantılar, depoyu klonlayan kullanıcılar için daha kolaydır. Mutlak bağlantılar, depoyu klonlarınca çalışmayabilir - bu nedenle, depo içindeki diğer dosyalara referans vermek için göreceli bağlantıları kullanmanızı öneririz. |
Resim Gösterildiği Temayı Belirtme
Markdown’da, bir resmin hangi temada görüntüleneceğini belirlemek için HTML <picture> öğesini prefers-color-scheme medya özelliğiyle birlikte kullanabilirsiniz. Işık ve karanlık renk modları arasında ayrım yapıyoruz, bu yüzden iki seçenek mevcut. Bu seçenekleri, koyu veya açık arka planlar için optimize edilmiş resimlerin gösterilmesi için kullanabilirsiniz. Bu, özellikle şeffaf PNG resimler için faydalıdır.
Örneğin, aşağıdaki kod, ışık temaları için bir güneş resmi ve karanlık temalar için bir ay resmi gösterir:
|
1 2 3 4 5 6 7 |
<picture> <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/25423296/163456776-7f95b81a-f1ed-45f7-b7ab-8fa810d529fa.png"> <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png"> <img alt="Açık modda bir güneşi ve karanlık modda yıldızlı bir ayı gösterir." src="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png"> </picture> |
Görev(İş) Listeleri
Bir iş listesi oluşturmak için, liste öğelerinin başına bir tire ve boşluk koyun, ardından [ ] ile devam edin. Bir görevi tamamlandı olarak işaretlemek için [x] kullanın.
|
1 2 3 4 5 |
- [x] #739 - [ ] https://github.com/octo-org/octo-repo/issues/740 - [ ] Tüm görevler tamamlandığında deneyime neşe katın :tada: |
Kişileri ve Takımları Bahsetme
GitHub üzerinde bir kişiyi veya takımı bahsetmek için kullanıcı adlarının veya takım adlarının yanına @ sembolünü ekleyerek bahsedebilirsiniz. Bu, bir bildirim tetikleyecek ve ilgili kişinin veya takımın konuşmaya dikkatini çekecektir. Bir kişi veya takım adınızı belirtmek için bir yorumu düzenlerseniz, kişiler ayrıca bir bildirim alacaklardır. Bildirimler hakkında daha fazla bilgi için “Bildirimler Hakkında” sayfasına bakın.
Not: Bir kişi, yalnızca depoya okuma erişimine sahipse ve depo bir kuruluşa aitse, kişi organizasyonun bir üyesi ise, bahsetme hakkında bir bildirim alır.
|
1 2 3 |
@github/support Bu güncellemeler hakkında ne düşünüyorsunuz? |
GitHub Markdown’ın işlenmiş bir ekran görüntüsü, takım bahsi “@github/support”ın kalın, tıklanabilir metin olarak nasıl işlendiğini gösteriyor.
Bir ana takımı belirttiğinizde, alt takımlarının üyeleri de bildirim alır, bu da birden fazla grupla iletişimi kolaylaştırır. Daha fazla bilgi için “Takımlar Hakkında” sayfasına bakın.
@ sembolünü yazmak, bir projedeki kişilerin veya takımların bir listesini getirecektir. Yazdıkça liste filtrelenir, bu yüzden aradığınız kişinin veya takımın adını bulduğunuzda, adı tamamlamak için ok tuşlarını kullanabilir ve tab veya enter tuşuna basarak adı tamamlayabilirsiniz. Takımlar için, @organization/takım-adı şeklinde girin ve o takımın tüm üyeleri konuşmaya abone olur.
Otomatik tamamlama sonuçları, depo işbirlikçileri ve konu üzerindeki diğer katılımcılarla sınırlıdır.
İfadeleri Emoji’lerle Zenginleştirme
Yazılarınıza emoji ekleyebilirsiniz. Bunun için :EMOJİKODU: şeklinde, bir iki nokta üst üste ve ardından emoji adını yazmanız yeterlidir.
|
1 2 3 |
@octocat :+1: Bu PR harika görünüyor - birleştirmeye hazır! :shipit: ???? |
GitHub Markdown’ın işlenmiş bir ekran görüntüsü, :+1: ve :shipit: için emoji kodlarının nasıl emoji olarak görsel olarak işlendiğini gösteriyor.
: yazmak, önerilen emoji listesini getirir. Yazdıkça liste filtrelenir, bu yüzden aradığınız emojiyi bulduğunuzda, vurgulanan sonucu tamamlamak için Tab veya Enter tuşuna basın.
Kullanılabilir emoji ve kodların tam listesi için Emoji-Cheat-Sheet sayfasına bakabilirsiniz.
Paragraflar
Yeni bir paragraf oluşturmak için metin satırları arasında boş bir satır bırakabilirsiniz.
Dipnotlar
İçeriğinize dipnot ekleyebilirsiniz, bunun için bu parantez sözdizimini kullanın:
|
1 2 3 4 5 6 7 8 9 10 11 |
İşte basit bir dipnot[^1]. Bir dipnot aynı zamanda birden fazla satıra sahip olabilir[^2]. --- [^1]: Kaynak. [^2]: Dipnot içinde satır aralıkları eklemek için, yeni satırlara 2 boşlukla başlayın. Bu ikinci satır. |
Uyarılar
Uyarılar, blok alıntı sözdizimine dayanan bir Markdown uzantısıdır ve önemli bilgileri vurgulamak için kullanılabilir. GitHub’da, içeriğin önemini belirtmek için farklı renkler ve simgelerle gösterilirler.
Uyarıları, kullanıcı başarısı için kesinlikle gerektiğinde ve okuyucuyu aşırı yüklememek için makale başına bir veya iki adetle sınırlayın. Ayrıca, uyarıları ardışık olarak yerleştirmekten kaçının. Uyarılar diğer öğelerin içine yerleştirilemez.
Bir uyarı eklemek için, uyarı türünü belirten özel bir blok alıntı satırı kullanın, ardından standart bir blok alıntıda uyarı bilgilerini ekleyin. Beş tür uyarı mevcuttur:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
> [!NOTE] > İçeriği hızlıca tararken dahi kullanıcıların bilmesi gereken yararlı bilgiler. > [!TIP] > İşleri daha iyi veya daha kolay yapmak için faydalı tavsiyeler. > [!IMPORTANT] > Kullanıcıların hedeflerine ulaşmaları için bilmesi gereken temel bilgiler. > [!WARNING] > Sorunları önlemek için hemen kullanıcı dikkatini çekmesi gereken acil bilgiler. > [!CAUTION] > Belirli eylemlerin riskleri veya olumsuz sonuçları hakkında tavsiyeler. |
README Dosyasının Temel Yapısı
Bir README dosyasının tipik yapısı aşağıdaki bölümlerden oluşur:
Başlık
Projenin adı ve kısa bir açıklaması. Bu bölümde projenizin ne olduğunu ve ne yaptığını birkaç cümleyle anlatmalısınız.
GitHub README dosyasında başlıklar oluşturmak için Markdown dili kullanılır. Markdown, basit bir biçimlendirme dilidir ve düz metin dosyalarında kullanılır. GitHub’da README dosyası genellikle README.md uzantısıyla oluşturulur. Başlıklar için # sembolü kullanılır ve bu sembolün sayısı başlık seviyesini belirler.
Örneğin,# en büyük başlık seviyesini, ## ikinci seviye başlığı, ### üçüncü seviye başlığı temsil eder.
Örnek 1: Örnek 1: Basit ve Açıklayıcı
|
1 2 3 4 |
# Barınak Uygulaması Bu uygulama barınaktaki hayvanlar hakkında bilgiler içermektedir. |
Örnek 2: Daha Detaylı ve Görsel Unsur İçeren
|
1 2 3 |
#  # C# Form Barınak Uygulaması |
Bu örnekte, bir logo eklenmiş ve proje hakkında daha detaylı bir açıklama yapılmış.
Örnek 3: Versiyon Bilgisi Eklenmiş
|
1 2 3 4 |
# Barınak v1.0.0 C# Form ile geliliştirilmiş basit bir uygulamadır. |
Örnek 4: Alt başlık Eklenmiş
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
# Barınak Uygulaması V3.4.0 Bu proje, örnek bir README dosyasının nasıl oluşturulacağını göstermektedir. ## Başlarken Bu bölüm, projeye nasıl başlayacağınızı açıklar. ### Gereksinimler Bu proje için aşağıdaki yazılımlar gereklidir: - Visual Studio - Laragon - HeideSQL |
Proje Açıklaması
Projenin amacını ve faydalarını daha ayrıntılı bir şekilde açıklayın. Hangi problemi çözdüğünüzü ve projenizin neden önemli olduğunu belirtin.
İpuçları
- Açık ve Anlaşılır Olun: Projenizin amacını ve faydalarını basit bir dille açıklayın.
- Problemi Belirleyin: Projenizin hangi problemi çözdüğünü net bir şekilde belirtin.
- Faydaları Vurgulayın: Projenizin kullanıcılarına sağlayacağı avantajları ve faydaları anlatın.
- Kullanım Alanları: Projenizin hangi durumlarda veya hangi alanlarda kullanılabileceğini belirtin.
- Hedef Kitle: Projenizin kimler için faydalı olduğunu açıklayın.
Örnekler
Örnek 1: Görev Yönetim Uygulaması
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
## Proje Açıklaması TaskMaster, kişisel ve profesyonel görevlerinizi yönetmenize yardımcı olan çok yönlü bir görev yönetim aracıdır. Günlük görevlerinizi düzenli tutarak verimliliğinizi artırmayı amaçlar. ### Problemi Belirleme Modern dünyada, insanlar işlerini ve kişisel görevlerini yönetmekte zorlanıyor. Unutulan işler, karışık görev listeleri ve zaman yönetimi sorunları sıkça karşılaşılan problemler arasında yer alıyor. ### Faydaları - **Organizasyon:** Görevlerinizi kategorilere ayırarak düzenli bir şekilde yönetmenizi sağlar. - **Hatırlatıcılar:** Belirli zamanlarda hatırlatıcılar ayarlayarak hiçbir görevi unutmamanızı sağlar. - **İşbirliği:** Ekip arkadaşlarınızla görevlerinizi paylaşarak işbirliğini artırır. - **Raporlama:** Detaylı raporlar ve analizlerle performansınızı takip etmenizi sağlar. TaskMaster, hem bireysel kullanıcılar hem de küçük ekipler için mükemmel bir çözümdür. |
Kurulum Talimatları
Kullanıcıların projeyi kendi bilgisayarlarında nasıl kurabileceklerini adım adım açıklayın. Bu bölümde gerekli bağımlılıklar ve kurulum komutları yer almalıdır.
Örnek:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
# Kurulum Talimatları Bu talimatlar, Windows Forms kullanarak basit bir barınak uygulamasını bilgisayarınızda nasıl kurabileceğinizi adım adım açıklar. Projenin çalışabilmesi için gerekli bağımlılıkların ve kurulum komutlarının nasıl kullanılacağını öğrenin. ## Gereksinimler Aşağıdaki yazılımların bilgisayarınızda yüklü olması gerekmektedir: - [Visual Studio](https://visualstudio.microsoft.com/) - [.NET Framework](https://dotnet.microsoft.com/download/dotnet-framework) - [MySQL Server](https://dev.mysql.com/downloads/mysql/) - [MySQL Connector/NET](https://dev.mysql.com/downloads/connector/net/) ## Adım 1: Projeyi Klonlayın İlk olarak, GitHub deposunu bilgisayarınıza klonlayın: ```bash git clone https://github.com/kullanici_adi/barinak-uygulamasi.git cd barinak-uygulamasi |
Kullanım Bilgileri
Projenizin nasıl kullanılacağını açıklayın. Örnek komutlar, giriş ve çıkışlar ile birlikte kullanım senaryolarını içerebilir.
Örnek:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# Kullanım Bilgileri Bu bölümde, barınak uygulamanızın nasıl kullanılacağını adım adım açıklanmaktadır. Aşağıda, kullanıcıların uygulamayı etkili bir şekilde kullanmalarına yardımcı olacak komutlar, girişler ve çıkışlar bulunmaktadır. ## Barınak Uygulamasını Başlatma Uygulamayı başlatmak için aşağıdaki adımları izleyin: 1. Bilgisayarınızda Visual Studio ile projeyi açın. 2. Proje çözümünde `BarinakUygulamasi` adlı proje seçeneğini belirleyin. 3. `Debug` menüsünden `Start Debugging` veya `Start Without Debugging` seçeneğini seçin. ## Yeni Hayvan Ekleme Yeni bir hayvan eklemek için: 1. Uygulama başladığında, ana pencerede "Yeni Hayvan Ekle" düğmesini tıklayın. 2. Açılan pencerede, hayvanın türü, adı, cinsi, yaşı ve diğer bilgileri girin. 3. "Kaydet" düğmesini tıklayarak yeni hayvanı veritabanına ekleyin. ## Varolan Hayvanları Görüntüleme ve Düzenleme Var olan hayvanları görüntülemek ve düzenlemek için: 1. Ana pencerede "Hayvanları Görüntüle" düğmesini tıklayın. 2. Açılan pencerede, mevcut hayvanları listeleyin. 3. Bir hayvanı seçerek üzerinde düzenleme yapın veya silmek için "Düzenle" veya "Sil" düğmelerini kullanın. ## Arama Yapma Belirli bir hayvanı veya türe göre arama yapmak için: 1. Ana pencerede "Arama" kutusuna aradığınız hayvanın adını veya türünü yazın. 2. Sonuçları filtrelemek için "Ara" düğmesini tıklayın. 3. Arama sonuçlarını gözden geçirin ve istediğiniz hayvanı seçin. ## Uygulamadan Çıkma Uygulamadan çıkmak için: 1. Uygulamanın ana penceresinde, sağ üst köşedeki "X" düğmesini tıklayın. 2. Çıkış onayı istenirse, "Evet" düğmesini tıklayarak uygulamadan çıkın. Bu adımları takip ederek barınak uygulamanızı etkili bir şekilde kullanabilirsiniz. Herhangi bir sorunla karşılaşırsanız, lütfen GitHub deposundaki sorunlar bölümüne bir hata raporu oluşturun. |
Katkıda Bulunma Rehberi
Diğer geliştiricilerin projeye nasıl katkıda bulunabileceklerini anlatın. Pull request ve issue açma talimatları, katkı kuralları ve iletişim bilgilerini içerebilir.
Örneğin:
- Pull Request ve Issue Açma Talimatları: Projeye katkıda bulunmak isteyenlerin nasıl pull request (çekme isteği) ve issue (sorun) açabileceklerini anlatan adımlar burada yer alır. Örneğin, GitHub kullanıcılarına yönelik adımlarla açıklanabilir.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
Pull Request Açma Adımları: 1. GitHub'da projenin deposuna gidin. 2. "Pull Request" sekmesine tıklayın. 3. "New Pull Request" düğmesine tıklayarak yeni bir pull request oluşturun. 4. Değişikliklerinizi ve nedenini açıklayan bir başlık ve açıklama yazın. 5. Pull request'i oluşturun. Issue Açma Adımları: 1. GitHub'da projenin deposuna gidin. 2. "Issues" sekmesine tıklayın. 3. "New Issue" düğmesine tıklayarak yeni bir issue oluşturun. 4. Sorununuzu açıklayan bir başlık ve açıklama yazın. 5. Issue'yi oluşturun. |
Katkı Kuralları: Projeye katkıda bulunurken dikkat edilmesi gereken kurallar bu bölümde belirtilir. Örneğin, kod standartları, test gereksinimleri, belgelendirme yönergeleri gibi kurallar açıklanabilir.
İletişim Bilgileri: Projeye katkıda bulunanlar için iletişim bilgileri sağlanır. Örneğin, proje sahibinin e-posta adresi, Discord veya Slack kanalı gibi iletişim kanalları burada belirtilebilir.
Lisans Bilgisi
Projenizin lisansını belirtin. Bu, projenizin nasıl kullanılabileceğini ve dağıtılabileceğini belirler.
Örneğin:
- Lisans Türü: Projede hangi lisansın kullanıldığı belirtilir. Örneğin, MIT Lisansı, GPL, Apache Lisansı gibi.
- Lisans Metni: Lisans metni burada belirtilir veya lisans dosyasına bir bağlantı sağlanır. Örneğin, MIT Lisansı altında yayımlanan bir proje için lisans metni şöyle olabilir:
|
1 2 3 4 5 |
MIT License Burada lisans metni yer alır. Projeye katkıda bulunanlar bu lisans koşullarını kabul etmiş sayılırlar. |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
# C# Form Barınak Uygulaması Bu proje, örnek bir README dosyasının nasıl oluşturulacağını göstermektedir. ## Başlarken Bu bölüm, projeye nasıl başlayacağınızı açıklar. ### Gereksinimler Bu proje için aşağıdaki yazılımlar gereklidir: - Visual Studio - Laragon - HeideSQL ### Kurulum Projeyi yerel makinenize klonlamak için aşağıdaki adımları izleyin: ```bash git https://github.com/hnkbilisim/barinak.git cd proje-adi |
Örnekler:
Çıktı:
Yorum Yap