CFOG's PIP, March 1987, Volume 5 No. 5, Whole No. 53, page 4
Guidelines on Developing and Packaging Software for the Public Domain
by Charlie Kestner
Addenda to "Basic Requirements":
2.d
Always ensure that the library contains a file listing the CRC values of all files present in the library. Create this file with CHEK15, and not the older CRCK program.
2.e
Include a short "FOR" notice, so users uploading file to OTHER remotes can use the SAME description that the original author used.
2.f
If the executable file is machinespecific, DO be sure to state same at the START of the DOC file. NOTHING is more irritating than downloading say, a 80k library (at longdistance rates) only to find that it ONLY runs on a computer OTHER than the one YOU own.
Addenda for "Other Tips":
1.a
Do NOT format your DOC file! Keep in mind that MOST remotes abort typing a file after 80 lines. It's VERY frustrating to attempt to type a DOC file online, only to have the remote abort it after you've viewed 60 lines of blankspace (and NOT even begun to read the actual file).
1.b
Do NOT format your DOC file with word processors that don't have pure ASCII capability. I guarantee that you will drive Perfect Writer users right up the wall when they have to view page after page of WordStar tildes! (Hint, Terry, hint!) If you MUST write the file with WordStar, please DO have the courtesy to convert it after editing.
4.a
If you don't include the source code (with user-settable equates), please DO include the addresses of patchpoints. If your software DOESN'T have user equates, consider adding them if need be. You like salt, I like pepper, and someone else likes garlic.
5.a
The source code is NOT the place for editorialising. Again, keep in mind the fact a lot of folk like to type out the beginning of the source code online. If you insist on filling the user's eyes (ears?) with your philosophy, chances are the remote will abort the type BEFORE the caller sees ANY code at all. (Reading this, you BYE/KMD folk?) If the history of updates is lengthy, put it in a SEPARATE file, keeping only the update dates in the source code.
5.b
If your source code requires compilation or assembling by something other than ASM, please include an executable file. It's highly annoying to find say, a great 'C' utility, and to ALSO find that the author neglected to put in ONLY the DOC file and the source code. It's kind of useless for those without that particular compiler.
Charlie Kestner, Asst/Sysop CBBS #1, (312) 545-8086 - 8, n, 1 - 300/1200/2400 - 24hrs. (219) 844-3121 (voice)