Загрузить PDFЗагрузить PDFHow.com.vn работает по принципу вики, а это значит, что многие наши статьи написаны несколькими авторами. При создании этой статьи над ее редактированием и улучшением работали авторы-волонтеры.
Количество просмотров этой статьи: 11 715.
Файл Readme - это небольшой по объему документ, который обычно прилагается к программе. Файлы Readme пишутся разработчиками программного обеспечения и содержат базовую информацию о программе, включая данные об установке или руководство о системных настройках, контактную информацию, лицензию, благодарности и информацию о версии ПО. Для распространения программного обеспечения важно знать, как следует писать файл Readme. Плохо написанный документ Readme может разочаровать, утомить пользователя, в то время как удачный вариант поможет ему с легкостью узнать базовую информацию о вашей программе.
Шаги
Загрузить PDF
Включите контактную информацию. Это, вероятно, самая важная часть документа Readme. Контактная информация позволит пользователю связаться с вами, чтобы предложить вам дополнить программу, задать вопрос, исправить ошибку или оплатить программу. Включите название компании, вебсайт, Email и телефонный номер (эта информация займет пару строк).- Пример приведен на картинке.
Вставьте дату в ваш Readme. Это небольшой, но очень важный шаг. Важно обозначить дату распространения вашей программы. Так пользователи будут в курсе обновлений версии программы, а также смогут определить, поддерживается ли она до сих пор.
Запишите название программы, версию и информацию о цене. Наверху напишите название приложения и номер версии. Ниже напишите цену за полную версию. Если вы распространяете программу при помощи физических носителей, таких как CD, можете не включать информацию о цене, потому что пользователи, вероятно, уже и так заплатили за программу.
Кратко опишите программу. В одном-двух предложениях дайте краткое описание вашей программы. Например: "Данное приложение отслеживает настроение пользователя, анализируя его активность в интернете, после чего изменяет пространство на рабочем столе таким образом, чтобы подстроиться под эмоциональное состояние пользователя."- Если у вашего программного обеспечения довольно широкий список функций, можете расширить описание на целый абзац или два. Можете использовать маркированный список, чтобы пронумеровать все функции и возможности программы.
Опишите минимальные требования для программы. В хорошем файле Readme должна быть информация, касающаяся минимальных требований для программы и инструкции по установке. Если для установки программы нужна еще одна часть программного обеспечения, не забудьте упомянуть об этом. Вы также можете включить информацию о рекомендованных требованиях (например, загрузка CPU).
Включите информацию о лицензии и авторских правах. В конце не забудьте вписать информацию о дате установления авторского права и лицензировании программы.Реклама
Советы
- Чтобы пользователям не надо было форматировать ваш файл, сохраните его в простом текстовом формате (.txt).
- В название файла Readme включите название программы; таким образом, пользователь будет искать файл Readme по названию программы.
Что вам понадобится
- Компьютер
- Текстовый редактор
Источники
Была ли эта статья полезной?
⚠️ Disclaimer:
Content from Wiki How Русский language website. Text is available under the Creative Commons Attribution-Share Alike License; additional terms may apply.
Wiki How does not encourage the violation of any laws, and cannot be responsible for any violations of such laws, should you link to this domain, or use, reproduce, or republish the information contained herein.
- - A few of these subjects are frequently censored by educational, governmental, corporate, parental and other filtering schemes.
- - Some articles may contain names, images, artworks or descriptions of events that some cultures restrict access to
- - Please note: Wiki How does not give you opinion about the law, or advice about medical. If you need specific advice (for example, medical, legal, financial or risk management), please seek a professional who is licensed or knowledgeable in that area.
- - Readers should not judge the importance of topics based on their coverage on Wiki How, nor think a topic is important just because it is the subject of a Wiki article.
