Как написать Readme

Файл Readme - это небольшой по объему документ, который обычно прилагается к программе. Файлы Readme пишутся разработчиками программного обеспечения и содержат базовую информацию о программе, включая данные об установке или руководство о системных настройках, контактную информацию, лицензию, благодарности и информацию о версии ПО. Для распространения программного обеспечения важно знать, как следует писать файл Readme. Плохо написанный документ Readme может разочаровать, утомить пользователя, в то время как удачный вариант поможет ему с легкостью узнать базовую информацию о вашей программе.

Шаги

1. 1 Включите контактную информацию. Это, вероятно, самая важная часть документа Readme. Контактная информация позволит пользователю связаться с вами, чтобы предложить вам дополнить программу, задать вопрос, исправить ошибку или оплатить программу. Включите название компании, вебсайт, Email и телефонный номер (эта информация займет пару строк).
   • Пример приведен на картинке.
2. 2 Вставьте дату в ваш Readme. Это небольшой, но очень важный шаг. Важно обозначить дату распространения вашей программы. Так пользователи будут в курсе обновлений версии программы, а также смогут определить, поддерживается ли она до сих пор.
3. 3 Запишите название программы, версию и информацию о цене. Наверху напишите название приложения и номер версии. Ниже напишите цену за полную версию. Если вы распространяете программу при помощи физических носителей, таких как CD, можете не включать информацию о цене, потому что пользователи, вероятно, уже и так заплатили за программу.
4. 4 Кратко опишите программу. В одном-двух предложениях дайте краткое описание вашей программы. Например: "Данное приложение отслеживает настроение пользователя, анализируя его активность в интернете, после чего изменяет пространство на рабочем столе таким образом, чтобы подстроиться под эмоциональное состояние пользователя."
   • Если у вашего программного обеспечения довольно широкий список функций, можете расширить описание на целый абзац или два. Можете использовать маркированный список, чтобы пронумеровать все функции и возможности программы.
5. 5 Опишите минимальные требования для программы. В хорошем файле Readme должна быть информация, касающаяся минимальных требований для программы и инструкции по установке. Если для установки программы нужна еще одна часть программного обеспечения, не забудьте упомянуть об этом. Вы также можете включить информацию о рекомендованных требованиях (например, загрузка CPU).
6. 6 Включите информацию о лицензии и авторских правах. В конце не забудьте вписать информацию о дате установления авторского права и лицензировании программы.

Советы

• Чтобы пользователям не надо было форматировать ваш файл, сохраните его в простом текстовом формате (.txt).
• В название файла Readme включите название программы; таким образом, пользователь будет искать файл Readme по названию программы.

Что вам понадобится

• Компьютер
• Текстовый редактор