Harika README

Harika README'lerın derlenmiş bir listesi

Güzel README'lerin öğeleri arasında, (bunlarla sınırlı olmamak üzere) resimler, ekran görüntüleri, GIF'ler, metin biçimlendirme öğeleri vb. bulunur.

Örnekler

• ai/size-limit - Proje logosu, net bir açıklama, ekran görüntüsü, adım adım kurulum talimatları.
• aimeos/aimeos-typo3 - Proje logosu, projenin ne yaptığına dair net bir açıklama, demo ekran görüntüsü, kolay gezinme için İçindekiler bölümü, kolay kurulum ve yapılandırma bölümleri ile ekran görüntüleri, daha fazla okuma için linkler gibi öğeler.
• ajeetdsouza/zoxide - Badgeler, proje GIF'i, özlü açıklama, hızlı linkler ve adım adım kurulum talimatları gibi öğeler.
• alichtman/shallow-backup - Projenin ne yaptığını net bir şekilde açıklayan açıklama, projenin nasıl çalıştığını gösteren bir GIF, kolay gezinme için İçindekiler bölümü, projeye özgü özellikleri veya durumları temsil eden rozetler, daha fazla okuma için linkler gibi öğeler, basit kurulum talimatları.
• alichtman/stronghold - Projenin ne yaptığını net bir şekilde açıklayan açıklama, projenin nasıl çalıştığını gösteren bir GIF, kolay gezinme için İçindekiler bölümü, projeye özgü özellikleri veya durumları temsil eden rozetler, daha fazla okuma için linkler gibi öğeler, basit kurulum talimatları.
• amitmerchant1990/electron-markdownify - Proje logosu, projenin ne olduğunu minimalist bir şekilde açıklayan tanım, projenin çalışmasını gösteren bir GIF, ana özellikler, kurulum kılavuzu, teşekkürler ve katkıda bulunanlar.
• amplication/amplication - Temiz proje logosu. kısa bir açıklama. Tüm özelliklerin açıklandığı şekilde. Temiz belgelendirme. Faydalı bağlantılar (web sitesi, belgeler, Discord). Katkıda bulunanların resimleri ve kullanıcı adlarıyla birlikte listesi.
• anfederico/Clairvoyant - Birden fazla rozet. Temiz logo. Basit kurulum talimatları. Projeye ilişkin açık bir genel bakış, bir şema eşliğinde. GIF demo. Kapsamlı kod örnekleri.
• ankitwasankar/mftool-java - Proje logosu, onunla elde edilebilecek kısa bir gösterim, kolay navigasyon için bir içindekiler listesi, önemli rozetler, temiz kurulum rehberi ve işlevselliği nasıl kullanacağınızı gösteren birden fazla kod parçası.
• aregtech/areg-sdk - Logo. Birden fazla bilgi ve istatistik rozeti. Fotoğraflarla katkıda bulunanların ve beğenenlerin listesi. Kolay gezinme için TOC ve "Başa dön" bağlantıları. Grafiklerle başlıklar. Konu gizle/göster menüsü. Proje açıklaması ve felsefesi. Klonlama ve entegrasyon talimatları. Birden fazla araçla hızlı derleme. Araç yapılandırma talimatları. Örnekler ve Demo projelerine referans. Kullanım örneklerine referans. Rehberlik ve Wiki sayfalarına referans. İletişim için rozetli bağlantılar. Projenin sosyal ağlarda paylaşılması için rozetli bağlantılar.
• Armync/Arminc-AutoExec - Zengin Markdown fonksiyonları, modern düzen, açıklayıcı açıklama ve önerilen topluluk standartlarına uygun.
• athityakumar/colorls - Birden fazla rozet. Temiz ekran görüntüleri. Basit kurulum talimatları. Kolay gezinme için TOC. İyi katkıda bulunan rehberi.
• ccostan/Home-AssistantConfig - Proje bannerı. Rozetler. Kolay gezinme.
• choojs/choo - Rozetler, temiz, açık. Yararlı bağlantılarla katlanabilir bir menü. Ana sorular için içindeki bir SSS. Destekçiler. İyi dil.
• chroline/well_app - Dikkat çekici projenin resmiyle temiz rozetler, ayrıca indirme bilgileri ve hızlı gezinme bağlantıları. Birden fazla açıklayıcı bölüme ayrılmış, her biri sarı emoji ile başlık içeriyor. Projeye, kullanılan teknolojilere ve nasıl katkıda bulunulacağına dair detayları içeriyor.
• create-go-app/cli - Temiz proje logosu. Faydalı rozetler (sürüm, kod stili, test kapsama, belgeler). Hızlı başlangıçla anlaşılabilir kurulum ve kullanım kılavuzu, video ekran görüntüsü, iyi belgelenmiş proje özelliklerini içeren TOC (terminalde çalışmanın demo kaydıyla), proje felsefesi notları ("neden başka bir tane"), en sık sorulan sorular ve daha fazlası.
• Day8/re-frame - Rozetler, logo, TOC vb. Teknoloji hakkında dev bir, iyi yazılmış bir deneme, nasıl kullanılacağı, ardındaki felsefe ve daha büyük ekosisteme nasıl uyum sağlayacağı hakkında.
• dbt-labs/dbt-core - Proje bannerı, ürüne yeni başlayanlara dostane olan açıklayıcı açıklama, aracın oluşturduğu belgelerin ekran görüntüsü ve Başlarken, dbt Topluluğuna Katılma, Hata Bildirimi, Kod Katkısı ve Davranış Kuralları gibi diğer kapsamlı sayfalar için özgün bağlantılar.
• dowjones/react-dropdown-tree-select - Hızlı bir demo için GIF ekran görüntüsü ile temiz açıklama. Birden fazla rozet, özgün ToC, çevrimiçi oyun alanı, hikaye kitabı, detaylı açıklama ve daha fazlası.
• easybase/easybase-react - Proje bannerı ve logo. Rozetler. Genişletilebilir gezinme bölümleri. Kısa açıklama ve amaç. Kolay gezinme için TOC. Kurulum demosu için GIF'ler. Birden fazla bilgilendirici görsel.
• emalderson/thephish - Proje logosu, bilgilendirici rozetler, hızlı demo için kullanışlı TOC, açıklayıcı açıklama, ekran görüntüleri, adım adım kurulum ve yapılandırma kılavuzu, katkı rehberleri, davranış kuralları, UML diyagramları, tutarlı etiketler, sorun ve çekme isteği şablonları, iyi belgelenmiş ve iyi açıklanmış kod, örnekler.
• github-changelog-generator/github-changelog-generator - Kolay gezinme için TOC. Açıklayıcı proje açıklaması. Kurulum ve kullanım bölümleri. Çıktı örneği. Harika özellik genel bakışı. Alternatiflerin listesi. SSS.
• gitpoint/git-point - Açıklayıcı açıklama. Proje logosu. App Store logoları. TOC. Temiz ekran görüntüleri. Özellik listesi. Detaylı kurulum süreci. Ana Sayfa.
• gofiber/fiber - Temiz proje logosu. Faydalı rozetler ve bağlantılar (diller değiştirici,

kod stili, test kapsama, belgeler, Discord kanalı). Projenin ne yaptığına dair açıklayıcı açıklama, hızlı başlangıç, performans tabloları, iyi belgelenmiş kod örnekleri (uzun içeriği gizleme yeteneğiyle), proje felsefesi notları ("projenin nedeni"), proje eklentileri için tablolar, katkıda bulunanların listesi, yıldız büyüme istatistikleri ve daha fazlası.

• Hexworks/Zircon - Readme'de kendi yazılımını kullanma. Projenin ne yaptığına dair açıklayıcı açıklama. Demo ekran görüntüsü. Kolay gezinme için TOC. Ekran görüntülerini görmek için kolay kurulum ve yapılandırma bölümleri. Daha fazla okuma için bağlantılar.
• httpie/httpie - Projenin ne yaptığının açıklaması. Demo ekran görüntüleri. Proje logosu. Kolay gezinme için TOC. Yapı rozetleri. Basit ve anlaşılır kurulum ve kullanım bölümleri. Örnekler bölümü içerir.
• iharsh234/WebApp - Proje ana sayfası. Projenin ne yaptığının açıklaması. Demo ekran görüntüsü. Basit kurulum ve kullanım bölümleri. Ortak kullanımlarla ilgili örnekler ve mobil demo bölümü içerir.
• iterative/dvc - Yeniden Yapılandırılmış Metin biçimi örneği, PyPi ile uyumlu. Logo, özel web sitesi benzeri menü. Nasıl çalıştığına dair pürüzsüz animasyon. Rozetler. İhtişamlı bir katkı bölümü.
• ivanperez-keera/Yampa - Açıklayıcı açıklama. Özellik listesi. Kolay gezinme için TOC. Basit kurulum talimatları. Kullanım kod örnekleri. GIF'ler ve uygulama mağazalarına bağlantılarla projelerin örnekleri. Belgeler ve yayınlar. Açık geliştirme/katkı kuralları.
• karan/joe - Proje logosu. Projenin ne yaptığının açıklaması. GIF demo. Kolay kurulum ve kullanım bölümleri.
• kopach/karma-sabarivka-reporter - Proje logosu. Faydalı rozetler, hızlı demo için ekran görüntüleri olan açıklayıcı readme. Açıklayıcı ToC.
• L0garithmic/FastColabCopy - Proje logosu. Minimalist açıklama. Rozetler. GIF demo. Proje Hakkında. Nasıl Kullanılır. Örnekler. Krediler. Ek Örnekler.
• ma-shamshiri/Human-Activity-Recognition - Güzel bir içerik tablosu. Proje logosu. Animasyonlu proje bannerı. Tam proje klasör yapısı. Projenin ne yaptığının açıklayıcı açıklaması. Güzel katkıda bulunanlar bölümü. Kolay gezinme.
• ma-shamshiri/Pacman-Game - Güzel bir içerik tablosu. Proje logosu. Animasyonlu proje bannerı. Her bir parçasını göstermek için uygun GIF'ler. Repo'daki tüm proje dosyalarının listesi ve işlevlerinin açıklaması. Tam yürütme talimatı.
• ma-shamshiri/Spam-Detector - Tüm proje dosyalarının açıklaması. Proje logosu. Animasyonlu proje bannerı. Özlü proje açıklaması. Açıklayıcı yürütme talimatı.
• MananTank/radioactive-state - Rozetler (sürüm, indirmeler, kapsama, boyut), Twitter Intent, Proje Logosu, Özellik listesi, Motivasyon, Kurulum, GIF'lerle örnekler, Emojiler, Katlanabilir Bölümler, Canlı Demolar, API detaylı kullanım, SSS'ler, Sohbet bağlantısı.
• Martinsos/edlib - Bilgilendirici rozetler (derleme, sürüm, yayın). Özlü açıklama. Özellik listesi. TOC. Ekran görüntüleri. Derleme ve projenize dahil etme için örneklerle açıklayıcı talimatlar. Hızlı başlangıç yapmanıza yardımcı olacak ortak

kullanımların listesi.

• microsoft/api-guidelines - İçerik tablosu. Açıklayıcı proje açıklaması. Proje logosu. Kolay gezinme için TOC. Ana bölümler ve alt başlıklar. Referanslar ve kaynaklar. İyi belgelenmiş ve ayrıntılı rehberlik.
• microsoft/TypeScript-React-Native-Starter - Proje logosu. Açıklayıcı proje açıklaması. Ana özellikler. Kurulum ve kullanım talimatları. Referanslar. Yardım alma yöntemleri.
• navdeep-G/samplemod - Proje logosu. Rozetler (sürüm, Python sürümü, belge durumu, düzenli testler). Proje açıklaması ve ne yaptığı hakkında özlü açıklama. Kolay gezinme için TOC. Kurulum ve kullanım talimatları. Örnekler.
• nlknguyen/papercrop - Açıklayıcı proje açıklaması. Proje logosu. Kolay gezinme için TOC. Özellikler ve avantajlar. Kurulum ve kullanım talimatları. SSS. API belgeleri. Katkı rehberi.
• OpenGenus/cosmos - Açıklayıcı proje açıklaması. Proje logosu. İçerik tablosu. Kolay gezinme. Hızlı başlangıç rehberi. Proje özellikleri ve genel bakış. Örnekler ve algoritmalar. Projeye katkıda bulunma kılavuzu.
• opsxcq/offline-mail - Proje logosu. Projenin ne yaptığına dair açıklama. Proje kurulumu, yapılandırma ve kullanımı hakkında açıklayıcı talimatlar. Katkıda bulunma kılavuzu ve geliştirici bilgileri.
• pyenv/pyenv - Proje logosu. Rozetler (sürüm, belge, test kapsama, lisans). Projenin ne yaptığına dair açıklama. Kolay gezinme için TOC. Kurulum ve kullanım talimatları. Hata ayıklama, SSS ve daha fazlası.
• rclone/rclone - Proje logosu. Açıklayıcı proje açıklaması. Faydalı rozetler (sürüm, dökümantasyon, forum, çekme isteği, lisans). Kolay gezinme için TOC. Kurulum ve kullanım talimatları. SSS. Yardım alma yöntemleri.
• sindresorhus/got - Proje logosu. Projenin ne yaptığının açıklaması. Faydalı rozetler (sürüm, indirme, bağış, MIT lisansı). Kolay gezinme için TOC. Kurulum ve kullanım talimatları. Örnekler. API referansı. Sorun bildirme ve çekme isteği şablonları.
• styfle/packagephobia - Proje logosu. Rozetler (sürüm, boyut, indirme, son değişiklikler, lisans). Projenin ne yaptığına dair açıklama. Hızlı kurulum talimatları. Kullanım örnekleri. API belgeleri.
• tannerlinsley/react-query - Proje logosu. Projenin ne yaptığına dair açıklama. Faydalı rozetler (sürüm, lisans, bağış). Kolay gezinme için TOC. Hızlı başlangıç talimatları. API belgeleri. Örnekler ve rehberler. Sık sorulan sorular. Katkı rehberi.
• twbs/bootstrap - Proje logosu. Açıklayıcı proje açıklaması. Faydalı rozetler (sürüm, lisan, indirme, kaynaklar). Kolay gezinme için TOC. Kurulum talimatları. Örnekler ve belgeler. Katkı rehberi. SSS. Duyurular ve daha fazlası.
• vercel/hyper - Proje logosu. Açıklayıcı proje açıklaması. Faydalı rozetler (sürüm, lisans, MIT, katılımcılar). Kolay gezinme için TOC. Kurulum ve kullanım talimatları. Örnekler ve API referansı. SSS ve diğer kaynaklar.
• vlang/v - Proje logosu. Projenin ne yaptığına dair açıklama. Rozetler (sürüm, lisans, destek). Kolay gezinme için TOC. Kurulum ve kullanım talimatları. Örnekler. Katkı rehberi ve daha fazlası.
• webtorrent/webtorrent - Proje logosu. Projenin ne yaptığına dair açıklama. Faydalı rozetler (sürüm, lisan, indirme). Kolay gezinme için TOC. Kurulum talimatları. Örnekler. API referansı. SSS ve daha fazlası.
• zeit/hyper - Proje logosu. Açıklayıcı proje açıklaması. Faydalı rozetler (sürüm, lisans, MIT, katılımcılar). Kolay gezinme için TOC. Kurulum ve kullanım talimatları. Örnekler ve API referansı. SSS ve diğer kaynak

Makaleler

• "README Yazmanın Sanatı - Kaliteli README'ler Nasıl Yazılır?" - Stephen Whitmore
• "Zarif README'ler" - Yegor Bugayenko
• "Harika Bir README Nasıl Yazılır?" - Caleb Thompson (thoughtbot)
• "README Odaklı Geliştirme" - Tom Preston-Werner
• "Açık Kaynak Projenizden Neden Faydalanmayacağımın İlk 10 Nedeni" - Adam Stacoviak
• "Bir Haftada 3000 Yıldız Kazanan Eski Bir GitHub Projesinden Ne Öğrendim?" - KyuWoo Choi

Araçlar:

• Amazing GitHub Template - Projelerinize başlamanız için README.md, LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, GitHub Issues, Pull Request'ler ve Actions şablonları içeren kullanışlı bir şablon.
• Common Readme - Node.js için ortak bir README stili. Bir kılavuz ve README oluşturucusu içerir.
• Feedmereadmes - README düzenleme ve projenin analizi/geri bildirimi için bir araç.
• GitHub Readme Stats - README için dinamik olarak oluşturulan özelleştirilebilir GitHub kartları. İstatistikler, ek pinler, en çok kullanılan diller ve WakaTime.
• Hall-of-fame - README'de katkıda bulunanlara tanınırlık göstermeye yardımcı olur. Yeni/trend/top katkıda bulunanlar. Her saat güncellenir.
• Make a README - README'lerin nasıl yazılacağına dair bir rehber. Canlı Markdown önizlemesi ile düzenlenebilir bir şablon içerir.
• README best practices - README.md dosyanızı kopyalayıp yapıştırmanız için bir yer.
• readme-md-generator - Güzel README.md dosyaları oluşturan bir komut satırı arayüzü.
• Readme.so - Projenizin README'sine ekleyebileceğiniz ve özelleştirebileceğiniz tüm bölümleri hızlı bir şekilde oluşturmanıza olanak tanıyan basit bir düzenleyici.
• READMINE - Yazılım projeleri için ayrıntılı, açıklayıcı ve kendini tanımlayan bir README dosyası şablonu; kopyalayıp ihtiyaçlarınıza göre düzenleyebilirsiniz.
• StackEdit - Tüm proje README'si için hızlı bir şekilde özelleştirebileceğiniz bölümleri içeren kullanıcı dostu bir çevrimiçi düzenleyici.
• Standard Readme - Standart bir README stil spesifikasyonu. Aynı zamanda spesifikasyona uygun README'ler oluşturmanıza yardımcı olacak bir oluşturucuya da sahiptir.
• user-statistician - Profil README'ler için ayrıntılı GitHub kullanıcı etkinliğini SVG olarak oluşturan bir GitHub projesi.

GIFler Oluşturma

README'nize animasyonlu bir gif eklemek, projenizin ne yaptığını hızlı bir şekilde gösterir ve okuyucunun dikkatini çeker. İşte projeniz için hızlı bir şekilde gif oluşturmanıza yardımcı olabilecek birkaç program:

• Gifox - 14,99 $ - Temiz kullanıcı arayüzü, kısayol tuşları, birçok gelişmiş özellik.
• Gifski - ÜCRETSİZ - Diğerlerine göre daha canlı renkler, ancak dosya boyutunu düşük tutuyor.
• Giphy Capture - ÜCRETSİZ - Giphy.com'a kolayca yükleme yapabilen, biraz sıkıcı kullanıcı deneyimi.
• LICEcap - ÜCRETSİZ - Daha az sezgisel, daha fazla özellik.
• Peek - ÜCRETSİZ - Linux kullanıcıları için basit ve kullanımı kolay.
• Recordit - ÜCRETSİZ - Basit, temiz bir kullanıcı arayüzü, ancak otomatik olarak Recordit'e yükleme yapıyor.
• ScreenToGif - ÜCRETSİZ - Açık kaynaklı, özelleştirilebilir kullanıcı arayüzü ve kolayca düzenlenebilir GIF'ler, hızlı başlangıç için ideal.
• terminalizer - ÜCRETSİZ - Terminalinizi kaydedin ve terminalde çalışan GIF resimleri veya web oynatıcısı oluşturun.
• ttystudio - ÜCRETSİZ - Komut satırı araçları için, baş ağrılarını ortadan kaldıran bir terminalden GIF kaydedici.
• vhs - ÜCRETSİZ - Basit bir betik diliyle güzel terminal GIF'leri oluşturun.

Geri bildirimler

• feedmereadmes - README düzenleme ve geri bildirim almak için ücretsiz bir hizmet. Projelerinizin olgunlaşma düzeyi hakkında size rehberlik etmek için README olgunluk modelini içerir.
• maintainer.io - Ücretsiz README standartlaştırma ve geri bildirim alma hizmeti, 'Audit rezervasyonu yap' seçeneğine tıklarsanız.

Katkı

Her zaman katkılarınızı bekliyorum! Lütfen önce katkı rehberine göz atın.

Lisans

Bu çalışma ile ilgili tüm telif hakları ve ilgili veya komşu hakları, mümkün olan en geniş ölçüde, Matias Singers tarafından feragat edilmiştir.