Kako pisati Readme: 6 koraka -

Readme datoteka je mali dokument koji se obično priključuje na program.Readme datoteke pišu programeri softvera i sadrže osnovne informacije o programu, uključujući instalacijske podatke ili sistemske postavke, kontakt informacije, licencu, zahvalnost i informacije o verziji.Da biste distribuirali softver, važno je znati kako napisati Readme datoteku. Loše pismeni dokument Readme može razočarati, zamrznuti korisniku, dok će mu uspješna opcija pomoći u vezi s lakoćom učenja osnovnih informacija o vašem programu.

Korake

Slika pod nazivom Pišite mi čitanje Korak 1

jedan. Omogućite kontakt podatke.Ovo je vjerovatno najvažniji dio Readme dokumenta.Podaci za kontakt omogućit će korisniku da vas kontaktira kako bi vam ponudio da dopunite program, postavite pitanje, ispravite grešku ili platite program. Uključite naziv kompanije, web lokaciju, e-poštu i telefonski broj (ove informacije će uzeti par žica).

Primjer je prikazan na slici.

Slika pod nazivom Napišite pročitajte me korak 2

2. Umetnite datum u svoju readme.To je mali, ali vrlo važan korak.Važno je odrediti datum distribucije vašeg programa. Dakle, korisnici će biti svjesni ažuriranja verzije programa, a moći će i utvrditi da li je do sada podržana.

Slika naslova napisati čitanje me korak 3

3. Snimite naziv programa, verzije i informacija o cijenama.Na katu Napišite naziv aplikacije i broj verzije.Ispod napišite cijenu za punu verziju. Ako distribuirate program koristeći fizičke medije, poput CD-a, možda ne uključuje informacije o cijenama, jer su korisnici vjerovatno već plaćeni za program.

Slika pod nazivom Pišite mi čitanje Korak 4

4. Ukratko opišite program.U jednoj dvije rečenice dajte kratak opis vašeg programa.Na primjer: "Ova aplikacija prati raspoloženje korisnika, analizirajući svoju aktivnost na Internetu, nakon čega se prostor na radnoj površini mijenja na takav način da prilagodi emocionalno stanje korisnika."

Ako vaš softver ima prilično širok popis funkcija, možete proširiti opis u cijeli odlomak ili dva. Možete koristiti označeni popis za broj svih funkcija i funkcija programa.

Slika pod nazivom Napišite pročitajte mi korak 5

pet. Opišite minimalne zahtjeve za program.U dobroj datoteci Readme, moraju postojati informacije u vezi sa minimalnim zahtjevima za upute za program i instalaciju.Ako vam je potreban drugi dio softvera za instaliranje programa, ne zaboravite to spomenuti. Takođe možete uključiti podatke o preporučenim zahtevima (na primer, CPU preuzimanje).

Slika pod nazivom Napišite pročitajte me Korak 6

6. Omogućite licencu i informacije o autorskim pravima. Na kraju ne zaboravite unijeti podatke o datumu programa autorskih prava i licenciranja.

Savjeti

Da ne trebate formatirati vašu datoteku, sačuvati ga u jednostavnom tekstualnom formatu (.PORUKA).
U nazivu datoteke Readme, omogućite ime programa - tako da će korisnik pretraživati datoteku Readme po imenu programa.

Sta ti treba

Računar
Tekst uređivač