Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic

Re: avoiding writing readme for scripts

by KM (Priest)
on Oct 16, 2000 at 18:45 UTC ( #36916=note: print w/replies, xml ) Need Help??

in reply to avoiding writing readme for scripts

When Larry says a virtue is to be Lazy, he didn't mean to be a Lazy SoB. Part of programming is to write the README files so users know how to use the stuff you write. Not everyone can read Perl, or read everyones style of Perl and the README helps to remedy this. If you used POD within your script, you could extract it.. otherwise, it would be good practice, especially for a student, to write a decent README for your script. Sometimes when writing how to use a script you can see things that don't make sense, aren't obvious, and things that in general would be good to fix. So, do everyone a favor, and write your README.. it is not programming, but still the work of any respectable programmer (IMO).


  • Comment on Re: avoiding writing readme for scripts

Replies are listed 'Best First'.
RE (tilly) 2: avoiding writing readme for scripts
by tilly (Archbishop) on Oct 16, 2000 at 19:13 UTC
    In fact Larry wants you to turn all of those normally bad things into virtues by doing them in an enlightened manner.

    Have hubris but maintain it intact by being good enough to justify it.

    Be lazy, but think ahead to anticipate demands on your time and head them off in advance. For instance it is less work to write good documentation then call RTFM than it is to answer questions.

    Be impatient but take it out by getting to good answers fast rather than complaining.

    In other words let each deadly sin redeem itself by motivating you to act in a virtuous manner. :-)

RE: Re: avoiding writing readme for scripts
by Anonymous Monk on Oct 16, 2000 at 18:50 UTC
    its not that i'm lazy... its just i'm patiently challenged. Boy you guys answer these questions really fast. That's amzing.

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://36916]
[LanX]: met a guy from Aberdeen durin holidays, liked Scotsish accent a lot ... very phonetic
[LanX]: ... understood everything after mentally write down what he said.
[choroba]: Trainspotting?
[choroba]: Ouch, trailing commas in JSON :-(
[LanX]: ... though there seems to exist a taxation for the letter 't' in Northern Bri''ain ;-)
[LanX]: never seen trainspotting in OV ... :(
[karlgoethebier]: LanX
[LanX]: They should teach Scottish in continental schools after Brexit !!!

How do I use this? | Other CB clients
Other Users?
Others exploiting the Monastery: (8)
As of 2018-02-19 10:42 GMT
Find Nodes?
    Voting Booth?
    When it is dark outside I am happiest to see ...

    Results (261 votes). Check out past polls.