Readme.txt проти README.txt

Я щойно відправив проект у Github, вніс зміни та ін. Це мене здивувало: я бачу в основному README.txt у проектах з відкритими джерелами, а файл, який я редагував, був Readme.txt. Це якась стандартизація чи я мав би залишити її так, як є?

Великі літери виділяються і роблять файл легко видимим, що має сенс, оскільки це, мабуть, перше, що новий користувач хотів би подивитися. (Або, принаймні, слід було б поглянути на…) Як уже говорили інші, імена файлів, що починаються з великої літери, будуть перераховані перед малими іменами в ASCIIbetical сортування ( LC_COLLATE=C), що допомагає зробити файл видимим з першого погляду.

Цей READMEфайл є частиною групи файлів, яку, як правило, очікує користувач безкоштовного програмного пакету. Інші - це INSTALL(інструкції зі створення та встановлення програмного забезпечення), AUTHORS(список дописувачів), COPYING(текст ліцензії), HACKING(як розпочати роботу над внеском, можливо, включаючи список вихідних точок TODO), NEWS(останні зміни) або ChangeLog(в основному зайві з системи управління версіями).

Ось що повинні сказати про файл стандарти кодування GNUREADME .

Розподіл повинен містити файл, названий READMEіз загальним оглядом пакета:

• назва пакету;
• номер версії пакета або посилається на те, де в пакеті можна знайти версію;
• загальний опис того, що робить пакет;
• посилання на файл INSTALL, який, в свою чергу, повинен містити пояснення процедури встановлення;
• коротке пояснення будь-яких незвичайних каталогів або файлів вищого рівня, або інші підказки для читачів, щоб знайти їх навколо джерела;
• посилання на файл, який містить умови копіювання. GPL GNU, якщо він використовується, повинен бути у файлі, який називається COPYING. Якщо використовується GNU LGPL, він повинен бути у файлі, який називається COPYING.LESSER.

Оскільки завжди добре прагнути якнайменше здивувати своїх користувачів, вам слід дотримуватися цієї конвенції, якщо немає вагомих причин відхилення. У світі UNIX розширення імен файлів традиційно використовувались економно, тому канонічне ім'я файлу READMEне має суфіксів. Але у більшості користувачів, мабуть, не виникне проблем із розумінням того, що названий файл README.txtмає те саме значення. Якщо файл записаний у Markdown , ім'я файлу на зразок README.mdтакож може бути розумним. Уникайте використання складніших мов розмітки, як HTML у програміREADMEфайл, однак, оскільки його слід зручно читати на текстовому терміналі. Ви можете вказати користувачам на посібник із програмним забезпеченням або на його он-лайн документацію, яка може бути написана у більш досконалому форматі, для отримання детальної інформації з READMEфайлу.

Традиційно файл називався README у верхньому регістрі, оскільки середовища командного рядка, які використовують алфавітне впорядкування, потім ставлять файл у верхній частині. Це робить їх легко помітними у великих каталогах.

Це, швидше за все, захоплення у світі Unix / Linux, де ви завантажуєте джерела та потім будуєте програмне забезпечення. Якщо такі файли, як README та INSTALL у верхній частині списку вмісту каталогу списку, полегшується побачити, що вони є, замість того, щоб переглядати весь вміст з інтерфейсу командного рядка. Цей самий базовий принцип працює і для github (і насправді він працює і в інтерфейсах GUI, придумайте це, тому він може все-таки заслужити)

Ні в якому разі не жорстке правило, але, швидше за все, те, що всі роблять за звичку, тому що це роблять інші проекти. Якщо немає явної причини НЕ, ви, ймовірно, повинні використовувати всі літери лише тому, що ви побачите, що він використовується таким чином у багатьох інших проектах. Це також іменування, яке Github використовує за замовчуванням при створенні нового сховища.

README зазвичай пишеться у верхньому регістрі. Таким чином команда lsUnix розмістила файл біля початку списку каталогів (великі літери надходять перед малими літерами в порядку впорядкування ASCII).