Hoe om `n readme te skryf

`N "Lees my" lêer is `n kort geskrewe dokument wat met `n program versprei word. Die Readme lêers word deur programontwikkelaars geskryf en bevat basiese en belangrike inligting oor die program, insluitende installasie- en opstellinginstruksies, kontakinligting, lisensie-inligting, erkennings en inligting oor die programweergawe. Om te leer hoe om `n Leem te skryf, is noodsaaklik vir die effektiewe verspreiding van die program. `N Lees my verkeerd geskrewe lêer kan die gebruiker frustreer, verwar of boor, terwyl `n effektiewe een die basiese elemente van u program vinnig kan leer.

Skryf-to-Read-Me-stap-2.jpg" klas ="beeld ligkas">

2

Sluit die datum in jou leesmom in. Dit is `n klein maar belangrike stap. Sluit `n enkele reël in wat die jaar waarin die program versprei is, bevat. Dit sal gebruikers waarsku om te kyk vir `n nuwer weergawe of om te verseker dat die aansoek steeds ondersteuning ontvang as die datum nie onlangs is nie.

Skryf-to-Read-Me-stap-3.jpg" klas ="beeld ligkas">

3

Sluit die naam van die program, die weergawe en die prysinligting in. Naby die bokant van die lees-me-lêer, bevat dit `n reël met die naam van die aansoek en die weergawe nommer. Hieronder bevat `n lyn met die prys van die volledige weergawe. As u die program met behulp van `n fisiese medium, soos CD, versprei, kan u die prysinligting ignoreer, aangesien die gebruiker waarskynlik reeds vir die program betaal het.

Skryf-to-Read-Me-stap-4.jpg" klas ="beeld ligkas">

4

Beskryf die program op `n kort en dwingende manier. Gebruik slegs een of twee sinne, insluitend die beskrywing van die program. `N Voorbeeld kan wees: "Hierdie program bepaal die gebruiker se bui deur hul aksies aanlyn te registreer, en verander die lessenaar omgewing om dit aan te pas by hierdie bui."

Skryf-to-Read-Me-stap-5.jpg" klas ="beeld ligkas">

5

Dit bied die basiese vereistes vir die installering van u program. `N Goeie readme moet ook inligting bevat oor die stelsel vereistes en installasie instruksies. As `n ander deel van die program nodig is om die program te laat loop, noem dit hier. U kan ook inligting bevat oor die gebruik van verwagte hulpbronne (byvoorbeeld CPU-gebruik).

Skryf-to-Read-Me-stap-6.jpg" klas ="beeld ligkas">

6

Sluit enige kopiereg- of lisensie-inligting in. Ten slotte, moet u die kopieregdatum verskaf en watter programlisensie-ooreenkoms die gebruik van u program beheer.