Softonic

README Üreteci

Adım 1 / 4 README.md
Sonraki

Boş depolar kötü bir ilk izlenimdir. Proje adını, tek satırlık bir sloganı, bir özellik listesini, kurulum komutunu, bir hızlı başlangıç parçacığını, yazarı ve lisansı girin; bu üreteç doğru bir başlık hiyerarşisi ve çitli kod bloklarıyla temiz bir Markdown README, yani GitHub’ın proje sayfanızda gösterdiği bölümleri üretir. Kopyalayın, deponuzun kökünde README.md olarak kaydedin ve push edin. Bölüm başlıkları İngilizce yazılır; bu, açık kaynak README dosyalarının neredeyse evrensel geleneğidir. Kendi metniniz ise, hangi dilde olursa olsun, girdiğiniz gibi görünür.

Bir README nasıl taslaklanır

  1. 1

    Temel bilgileri ekleyin

    Proje adı, isteğe bağlı bir depo URL'si ve tek satırlık bir slogan. Ad `#` başlığı olur; slogan da altındaki alıntı olur.

  2. 2

    Özellikleri ve bir hızlı başlangıç listeleyin

    Her satırda bir özellik (her biri bir madde olur), artı çitli bir kod bloğuna sarılan kısa bir hızlı başlangıç parçacığı.

  3. 3

    Kurulum, lisans ve yazar

    Kurulum komutu, Installation altındaki bir `bash` kod bloğuna girer; lisansı (MIT, Apache-2.0…) ve isteğe bağlı bir yazar satırı ekleyin.

  4. 4

    Markdown'ı kopyalayın

    Kopyala'ya basın ve çıktıyı deponuzun kökünde `README.md` olarak yapıştırın. Push edin; işlenmiş sürüm proje sayfasında görünür.

İyi bir README neler içerir

GitHub’ın kendi stil kılavuzu ve yaygın kullanılan standard-readme spesifikasyonu sıra konusunda hemfikirdir. Göz gezdirilebilir kısımları en üste koyun, deponuza gelen bir insan, okumaya devam edip etmeyeceğine 20 saniyede karar verir.

Bölüm Konum Amaç
Başlık + slogan Satır 1–2 # Project ardından ne yaptığını anlatan bir cümle
Rozetler Satır 3–5 CI durumu, npm sürümü, lisans, kapsam
Kurulum Görünür alanda Birinin kopyalayabileceği tek bir komut
Kullanım Görünür alanda Çıktı üreten minimum uygulanabilir parçacık
API / seçenekler Orta Bayrak, yapılandırma anahtarı veya uç nokta tabloları
Katkı Sonlara doğru CONTRIBUTING.md, davranış kuralları, PR kurallarına bağlantı
Lisans Son SPDX tanımlayıcısı artı LICENSEa bağlantı

Gerçekten yardımcı olan rozetler

Shields.io URL’leri öngörülebilir bir desen izler: https://img.shields.io/badge/<label>-<message>-<color>.svg. Yararlı canlı rozetler gösteriş ölçütlerini değil, derleme durumunu, paket sürümünü ve indirme sayılarını gösterir. Dört rozet genellikle yeterlidir; fazlası gürültüdür.

Yaygın README hataları

  • Kurulum’un 1. satırında kurulum komutu olmaması. Okurlar npm install veya pip install arar; düzyazının arkasına gizleyin, giderler.
  • 3 MB olan ekran görüntüleri. 800 px genişliğe yeniden boyutlandırın ve sıkıştırın, GitHub onları her halükârda sunar ama mobil okurlar bant genişliği bedelini öder.
  • Güncel olmayan rozetler. Kırmızı bir CI rozeti ziyaretçilere projenin bozuk olduğunu söyler. Ya CI’yı düzeltin ya da rozeti kaldırın.
  • Eksik lisans. Lisans olmadan kodunuz varsayılan olarak “tüm hakları saklıdır” durumundadır ve şirketler onu kullanamaz.

Sık Sorulan Sorular

Evet. Çitli kod blokları, madde işaretli listeler ve ATX stili başlıklar (# öneki) GitHub, GitLab ve Bitbucket’te değişiklik olmadan işlenir. Kurulum komutu bash bloğu olarak etiketlenir; hızlı başlangıç bloğu ise dili kendiniz belirleyebilesiniz diye etiketsiz bırakılır.

Çoğu ekosistem için README.md. .rstyi yalnızca belgeleri Read the Docs’ta bulunan bir Python paketi yayımlıyorsanız ve Sphinx’in dosyayı açılış sayfası olarak yeniden kullanmasını istiyorsanız kullanın.

Bir depo URL’si sağladığınızda, üreteç tek bir statik lisans rozeti ekler (https://img.shields.io/badge/license-<type>-blue.svg). Canlı rozetler (derleme durumu, sürüm, indirmeler) için bir shields.io URL desenini kopyalayıp çıktıya kendiniz yapıştırın.

Hayır. README, form değerlerinden birleştirilir ve hiçbir şey kaydedilmez. Sekmeyi kapatın, veri gider.

İlgili Araçlar

ASCII Tablosu Referansı

NUL, LF ve DEL dahil her kod için ondalık, onaltılık, sekizlik ve ikili değerlerle HTML sayısal karakter başvurusu gösterimini sunan tam ASCII tablosu.

HTML Karakter Referansı

HTML varlıklarının aranabilir listesi; adlandırılmış ve sayısal kodlarıyla birlikte özel karakter ve semboller için tek tıkla kopyalama.

FPS Sayacı

requestAnimationFrame ile tarayıcı FPS değerini ölçün: yumuşatma, en düşük ve en yüksek kare hızı, uyarı eşiği ve isteğe bağlı grafik. Yerel çalışır, yükleme ve API yoktur.

Klavye kısayolları başvurusu

macOS, Windows ve Linux’ta VS Code, Chrome ve GNU Readline kullanan Bash için belgelenmiş varsayılan kısayolları arayın.

E-posta Doğrulayıcı

Bir e-posta adresini doğrulayın: RFC 5322 sözdizimi kontrolü, canlı MX kaydı sorgulama, ayrıca yerel kısım, alan adı ve uzunluk bilgileri. Hiçbir e-posta gönderilmez.

EditorConfig Oluşturucu

Girinti, satır sonu ve karakter kümesi kurallarınızdan bir .editorconfig oluşturun, ardından deponuzdaki her dil için doğru bölümü ekleyin: Python, Go, YAML, Makefile ve daha fazlası.

Araç diğer dillerde mevcuttur