Како да напишете ReadMe: 6 чекори

Датотеката README е мал документ кој обично е прикачен на програмата.Readme датотеки се напишани од страна на развивачите на софтвер и содржат основни информации за програмата, вклучувајќи податоци за инсталација или системски поставки, информации за контакт, лиценца, благодарност и информации за верзијата.За да го дистрибуирате софтверот, важно е да знаете како да напишете датотека readme. Лошо напишаниот документ за читање може да ги разочара, да го уништи корисникот, додека успешната опција ќе му помогне со леснотија да ги научи основните информации за вашата програма.

Чекори

Сликата напишано напише ме читај чекор 1

Еден. Овозможи информации за контакт.Ова е веројатно најважниот дел од документот README.Информациите за контакт ќе му овозможат на корисникот да ве контактира за да ви понуди за дополнување на програмата, поставувајте прашање, исправете ја грешката или ја плаќате програмата. Вклучете го името на компанијата, веб-страница, е-пошта и телефонски број (оваа информација ќе потрае пар на жици).

Еден пример е прикажан на сликата.

2. Внесете го датумот во вашиот readme.Тоа е мал, но многу важен чекор.Важно е да го означите датумот на дистрибуција на вашата програма. Така корисниците ќе бидат свесни за ажурирањата на верзијата на програмата, а исто така ќе можат да одредат дали е поддржана досега.

3. Запишете го името на програмата, верзијата и информациите за цените.Горе напишете го името на апликацијата и бројот на верзијата.Подолу напишете ја цената за целосната верзија. Ако ја дистрибуирате програмата користејќи физички медиуми, како што се CD, не можете да ги вклучите информациите за цените, бидејќи корисниците веројатно веќе платени за програмата.

Сликата е напишано напише ме чита Чекор 4

Четири. Накратко опишете ја програмата.Во една-две реченици, дадете краток опис на вашата програма.На пример: "Оваа апликација го следи расположението на корисникот со анализа на својата активност на интернет, по што го менува просторот на работната површина на таков начин што ќе ја прилагоди емоционалната состојба на корисникот."

Ако вашиот софтвер има прилично широка листа на функции, можете да го проширите описот на целиот став или два. Можете да користите означена листа за број на сите функции и карактеристики на програмата.

Сликата е напишано напише ме чита Чекор 5

Пет. Опишете ги минималните барања за програмата.Во добра датотека README, мора да има информации во врска со минималните барања за инструкциите за програмата и инсталацијата.Ако ви треба друг дел од софтверот за да ја инсталирате програмата, не заборавајте да го споменете. Можете исто така да вклучите информации за препорачаните барања (на пример, преземање на процесорот).

6. Овозможи информации за лиценца и авторски права. На крајот не заборавајте да внесувате информации за датумот на програмата за авторски права и лиценцирање.

Совети

За да не треба да ја форматирате вашата датотека, да ја зачувате во едноставен формат на текст (.Txt).
Во името на датотеката README, овозможете го името на програмата - така што корисникот ќе ја бара датотеката README со името на програмата.

Што ви треба

Компјутер
Уредувач на текст