Cum se scrie Readme: 6 pași

Fișierul README este un mic document care este de obicei atașat programului.Fișierele README sunt scrise de dezvoltatorii de software și conțin informații de bază despre program, inclusiv date de instalare sau setări de sistem, informații de contact, licență, recunoștință și informații despre versiune.Pentru a distribui software-ul, este important să știți cum să scrieți un fișier readme. Documentul readme slab scris poate dezamăgi, de a anvelifica utilizatorul, în timp ce o opțiune de succes îl va ajuta cu ușurință de a învăța informațiile de bază despre programul dvs.

Pași

Imagine intitulată Scrieți-mi un Pasul 1

unu. Activați informațiile de contact.Aceasta este probabil cea mai importantă parte a documentului Readme.Informațiile de contact vor permite utilizatorului să vă contacteze pentru a vă oferi să completați programul, să puneți o întrebare, să corectați eroarea sau să plătiți programul. Includeți numele companiei, site-ul web, e-mail și numărul de telefon (aceste informații vor lua o pereche de șiruri de caractere).

Un exemplu este afișat în imagine.

Imagine intitulată Scrieți o citire Pasul 2

2. Introduceți data în readme.Este un pas mic, dar foarte important.Este important să desemnați data de distribuție a programului dvs. Utilizatorii vor fi conștienți de actualizările versiunii programului și vor putea, de asemenea, să determine dacă este susținută până acum.

Imagine intitulată Scrieți un citiți Mine Pasul 3

3. Înregistrați numele programului, versiunii și informațiile despre preț.La etaj scrie numele aplicației și numărul versiunii.Mai jos Scrieți prețul pentru versiunea completă. Dacă distribuiți programul utilizând suporturi fizice, cum ar fi CD, este posibil să nu includeți informații despre preț, deoarece utilizatorii probabil deja plătiți deja pentru program.

Imagine intitulată Scrieți o citire ME Pasul 4

4. Descrieți pe scurt programul.În două propoziții, dați o scurtă descriere a programului dvs.De exemplu: "Această aplicație monitorizează starea de spirit a utilizatorului, analizând activitatea pe Internet, după care spațiul de pe desktop se schimbă astfel încât să ajusteze starea emoțională a utilizatorului."

Dacă software-ul dvs. are o listă destul de largă de funcții, puteți extinde descrierea la un întreg paragraf sau două. Puteți utiliza o listă marcată pentru a număra toate funcțiile și caracteristicile programului.

Imagine intitulată Scrieți-mi o citire Pasul 5

cinci. Descrieți cerințele minime pentru program.Într-un fișier bun readme, trebuie să existe informații cu privire la cerințele minime pentru instrucțiunile de program și de instalare.Dacă aveți nevoie de o altă parte a software-ului pentru a instala programul, nu uitați să o menționați. De asemenea, puteți include informații despre cerințele recomandate (de exemplu, descărcarea CPU).

Imagine intitulată Scrieți o citire Pasul 6

6. Activați licența și informațiile privind drepturile de autor. La final nu uitați să introduceți informații la data programului de autor și licențiere.

sfaturi

Pentru a nu fi nevoie să formatați fișierul, salvați-l într-un format simplu de text (.TXT).
În numele fișierului README, activați numele programului - astfel încât utilizatorul va căuta fișierul README cu numele programului.

De ce ai nevoie

Calculator
Editor de text