Obsah

• Kroky
• Tipy
• Čo potrebuješ

Súbor Readme je malý dokument, ktorý je zvyčajne súčasťou programu. Súbory Readme sú napísané vývojármi softvéru a obsahujú základné informácie o programe, vrátane informácií o inštalácii alebo sprievodcu nastaveniami systému, kontaktné informácie, licenciu, ocenenia a informácie o verzii softvéru. Pri distribúcii softvéru je dôležité vedieť, ako napísať súbor Readme. Zle napísaný súbor Readme môže byť pre užívateľa frustrujúci a únavný, zatiaľ čo dobrý text mu môže pomôcť ľahko sa naučiť základné informácie o vašom programe.

Kroky

1. 1 Zahrňte kontaktné informácie. Toto je pravdepodobne najdôležitejšia časť dokumentu Readme. Kontaktné informácie umožnia používateľovi vás kontaktovať s cieľom navrhnúť vám doplnenie programu, položenie otázky, opravu chyby alebo zaplatenie programu. Zahrňte názov spoločnosti, webovú stránku, e -mail a telefónne číslo (tieto informácie budú trvať niekoľko riadkov).
   • Príklad je zobrazený na obrázku.
2. 2 Vložte dátum do súboru Readme. Toto je malý, ale veľmi dôležitý krok. Je dôležité označiť dátum distribúcie vášho programu. Používatelia tak budú mať prehľad o aktualizáciách verzií programu a tiež budú môcť určiť, či sú stále podporované.
3. 3 Poznamenajte si názov programu, verziu a informácie o cenách. V hornej časti napíšte názov aplikácie a číslo verzie. Nižšie napíšte cenu za plnú verziu. Ak distribuujete program pomocou fyzických médií, ako je napríklad disk CD, nemusíte uvádzať informácie o cenách, pretože používatelia za program pravdepodobne už zaplatili.
4. 4 Stručne popíšte program. Vetu alebo dve stručne popíšte svoj program. Napríklad: „Táto aplikácia sleduje náladu používateľa analýzou jeho aktivity na internete a potom zmení priestor na pracovnej ploche takým spôsobom, aby sa prispôsobil emočnému stavu používateľa.“
   • Ak má váš softvér pomerne široký rozsah funkcií, môžete popis rozšíriť o celý odsek alebo dva. Zoznam s odrážkami môžete použiť na očíslovanie všetkých funkcií a vlastností programu.
5. 5 Popíšte minimálne požiadavky na program. Dobrý súbor Readme by mal obsahovať informácie o minimálnych požiadavkách na program a pokyny na inštaláciu. Ak na inštaláciu programu potrebujete ďalší softvér, nezabudnite to spomenúť. Môžete tiež zahrnúť informácie o odporúčaných požiadavkách (napríklad o zaťažení procesora).
6. 6 Zahrňte informácie o licencii a autorských právach. Na konci nezabudnite uviesť informácie o dátume vzniku autorských práv a licencii programu.

Tipy

• Aby ste zabránili používateľom formátovať váš súbor, uložte ho vo formáte obyčajného textu (.txt).
• Do názvu súboru Readme zadajte názov programu; používateľ teda vyhľadá súbor Readme podľa názvu programu.

Čo potrebuješ

• Počítač
• Textový editor