Herkes README Bir dosya gördü sanırım, ama en az miktarda enerji üzerine geçirdi README mükemmel bir dosya yazmak için kesin rehber istiyorum.

• README dosya nedir?
• Ben bu yaz ne yapmalıyım?
• Tam olarak nasıl bir format?

Yan not:

Karşılayan bir örnek olarak "bu mükemmel bir README OMG!" "OMG bu README",-cups-manager gnome için bir link attım bir işe yaramaz Yorum olarak README. Açıklamayı şimdi muhtemelen ölü olması nedeniyle kaldırılır this gist içerik kopyaladım böylece link.

Diğerleri belirttiği gibi, README basit ve kısa olmalıdır, ama iyi bir README özellikle eğer komut satırı ayrıştırma kütüphane parametre gibi bir şey için zaman kazandırabilir.

İçermelidir ben de şöyle düşünüyorum:

• proje adı ve alt modülleri ve kütüphaneleri (bazen farklı ve yeni kullanıcılar için çok kafa karıştırıcı isimleri var)
• proje ve alt modülleri ve kütüphaneler tüm açıklamaları
• 5 satır kodu nasıl Pasajı kullandım eğer burası bir kütüphane
• telif hakkı ve lisans bilgileri (veya "") Okuma LİSANS
• talimat belgeleri kapmak için
• yüklemek, yapılandırmak ve programları çalıştırmak için talimatlar
• bunu oluşturmak için kod ve detaylı talimatları en son kapmak için talimat (veya hızlı bir bakış ve "") Okuma YÜKLEYİN
• yazarlar listesi veya "Okur YAZAR"
• adaylığı, özellik istekleri, yamalar gönderin, e-posta listesi katıl, duyurular, formlar, kullanıcı ya da dev topluluğuna katılmak için talimatlar
• diğer iletişim bilgileri (e-posta adresi, web sitesi, şirket adı, adresi, vb)
• eğer kısa bir geçmişi değiştirme ya da başka bir çatal
• yasal bildirimler (şifre falan)

Apache HTTP Server henüz iyi README bir basit vardır. Online GNU kullanılabilir buldum güzel bir tane daha var README Olun.

Biçimlendirme başı olarak, sopa Unıx geleneklerine mümkün olduğunca söyleyebilirim, ve/veya kullanılması özellikle README işler github projeleri için bir fiyat indirimi.html olarak md.

• ASCII eğer README İngilizce yazılmış ise tek karakter
• mümkünse İngilizce yazın, iki harfli README gibi bir dil kodu uzantısı ile çevrilmiş sürüm gemi.ja
• Satır başına 80 karakter veya daha az
• paragraflar arasında tek bir boş satır
• başlıkları altında tire
• girinti kullanarak boşluk (0x20) sekmesini değil

Hepsini bir araya getirirsek...

Documentation
-------------

GNU make is fully documented in the GNU Make manual, which is contained
in this distribution as the file make.texinfo.  You can also find
on-line and preformatted (PostScript and DVI) versions at the FSF's web
site.  There is information there about ordering hardcopy documentation.

  http://www.gnu.org/
  http://www.gnu.org/doc/doc.html
  http://www.gnu.org/manual/manual.html 

Wikipedia olarak tanımlar:

Readme (Beni Oku ya da) bir dosya veya dizini Bir arşive diğer dosyalar hakkında bilgi içerir ve çok yaygın bir bilgisayar yazılımı ile dağıtılır.

ve aşağıdaki içeriği listeler:

• yapılandırma talimatları
• yükleme yönergeleri
• kullanım talimatları
• bir dosya listesi
• telif hakkı ve lisans bilgileri
• distribütör ya da programcı için iletişim bilgileri
• bilinen hatalar
• sorun giderme
• kredi ve alındılar
• bir changelog