Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
 Readmes or massive comments? What's your preference?
#19
It depends on the size of the script. (And of course the script itself)
For decently sized scripts I prefer to have the inline documentation intended for other scripters with a topic (or readme) which explain how to use it for the intended audience of the script.

For readme present in the downloadable script demo I'd prefer .txt or .pdf if .txt is not feasible.
I would definitely not prefer .html, especially not if there are images. It's much easier with a single file rather than the numerous files for an html version.
For the topic I utilize BBCode since it's easier since I don't have a web server.
[Image: ZeriabSig.png]
Reply }


Messages In This Thread
Readmes or massive comments? What's your preference? - by Zeriab - 06-23-2009, 02:22 AM

Possibly Related Threads…
Thread Author Replies Views Last Post
  Text files, HTML pages or giant comment blocks? What's the end-user's preference? PK8 3 6,345 06-29-2011, 01:21 PM
Last Post: Kain Nobel



Users browsing this thread: