Задаволены

• крокі
• парады
• Што вам спатрэбіцца

Файл 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 па назве праграмы.

Што вам спатрэбіцца

• Камп'ютар
• тэкставы рэдактар