Benioku.txt ve README.txt

Github'da bir proje yaptım, değişikliklerimi yaptım. Bu beni meraklandırdı: Açık kaynak projelerinde çoğunlukla README.txt görüyorum ve düzenlediğim dosya Benioku.txt idi. Bu bir çeşit standardizasyon mu yoksa olduğu gibi bırakmalı mıyım?

Tüm büyük harfler dikkat çeker ve dosyayı kolayca görünür kılar; bu da yeni bir kullanıcının aramak isteyeceği ilk şey olduğu için mantıklıdır. (Ya da en azından bakmalıydım ...) Başkalarının daha önce de söylediği gibi, büyük harfle başlayan dosya adları ASCIIbetical sort ( LC_COLLATE=C) içindeki küçük harflerden önce listelenir ve bu da dosyanın ilk bakışta görünmesini sağlar.

READMEDosya bir özgür yazılım paketinin bir kullanıcı normal bulmak beklenir dosyaların bir demet bir parçasıdır. Diğerleri INSTALL(yazılımın oluşturulması ve kurulması için talimatlar), AUTHORS(katkıda bulunanlar listesi), COPYING(lisans metni), HACKING(katkıda bulunmak için nasıl başlamalı, belki de bir TODO başlangıç ​​noktası listesi dahil), NEWS(son değişiklikler) veya ChangeLog(çoğunlukla gereksiz sürüm kontrol sistemleri).

Bu nedir GNU Kodlama Standartları hakkında söylemek zorunda READMEdosyanın.

Dağıtım README, pakete genel bir bakış içeren bir dosya içermelidir :

• paketin adı;
• paketin sürüm numarası veya paketin içinde sürümün bulunduğu yere bakın;
• paketin ne yaptığının genel bir açıklaması;
• INSTALLkurulum prosedürünün bir açıklamasını içermesi gereken dosyaya bir referans ;
• olağandışı üst düzey dizinlerin veya dosyaların veya okurların kaynak çevresinde yollarını bulmaları için diğer ipuçlarının kısa bir açıklaması;
• kopyalama koşullarını içeren dosyaya bir referans. GNU GPL, kullanılıyorsa, adı verilen bir dosyada olmalıdır COPYING. GNU LGPL kullanılıyorsa, adı verilen bir dosyada olmalıdır COPYING.LESSER.

Kullanıcılarınız için en az sürpriz yapmak için çabalamak her zaman iyi olduğu için, bir sapma için zorunlu nedenler olmadıkça bu sözleşmeyi izlemelisiniz. UNIX dünyasında, dosya adı uzantıları geleneksel olarak az kullanılırdı, bu nedenle dosyanın kanonik adı READMEherhangi bir soneksizdir. Ancak çoğu kullanıcı muhtemelen adlı bir dosyanın README.txtaynı anlama sahip olduğunu anlama konusunda hiçbir sıkıntı yaşamaz. Dosya Markdown ile yazılmışsa , bunun gibi bir dosya adı README.mdda makul olabilir. İçinde HTML gibi daha karmaşık biçimlendirme dilleri kullanmaktan kaçınınREADMEAncak, yalnızca metin bir terminalde okumak uygun olması nedeniyle dosya. READMEDosyadan ayrıntılar için, kullanıcıları yazılımın kılavuzuna veya daha karmaşık bir biçimde yazılmış olan çevrimiçi belgelerine yönlendirebilirsiniz .

Geleneksel olarak, dosya büyük harfle README olarak adlandırılırdı, çünkü alfabetik sıralamayı kullanan komut satırı ortamları daha sonra dosyayı en üste koyardı. Bu, büyük dizinlerde onları kolayca görülebilir kılar.

Büyük olasılıkla kaynakları indirebileceğiniz ve ardından yazılımınızı oluşturacağınız Unix / Linux dünyasından bir sahip olma. README ve INSTALL gibi dosyaların 'dizin dizini içeriği' görünümünün üstünde olması, tüm içeriğe bir komut satırı arayüzünden göz atmak yerine, orada olduklarını görmeyi kolaylaştırır. Aynı temel ilke github için de işe yarıyor (ve aslında GUI arayüzlerinde de işe yarıyor, düşünmeye başlıyor, bu yüzden hala hak ediyor olabilir)

Kesinlikle zor bir kural değil, fakat herkesin alışkanlık olarak yaptığı bir şey, çünkü diğer projeler bunu yapıyor. Yapmamanın belirli bir sebebi yoksa, muhtemelen tüm kapakları kullanmanız gerekir, çünkü bir çok başka projede de bu şekilde kullanıldığını görürsünüz. Aynı zamanda, yeni bir depo oluştururken Github'ın kullandığı varsayılan adlandırmadır.

README genellikle büyük harfle yazılmıştır. Bu şekilde lsUnix komutu, dosyayı dizin listesinin başına yakın bir yere yerleştirmiştir (büyük harfler ASCII sıralamasında küçük harfler önce gelir).