[912] in Athena Bugs
locker status; what a README file should contain
daemon@ATHENA.MIT.EDU (Henry Mensch)
Tue Sep 13 19:11:10 1988
Date: Tue, 13 Sep 88 19:10:27 EDT
From: henry@GARP.MIT.EDU (Henry Mensch)
To: rel-eng@ATHENA.MIT.EDU
Cc: bugs@ATHENA.MIT.EDU, roman@ATHENA.MIT.EDU, djf@ATHENA.MIT.EDU,
Reply-To: henry@GARP.MIT.EDU
top-level
README vaxbin rtbin executable docs notes
kcl XXX XXX XXX XXX XXX [1]
xmath XXX XXX [2]
hoops XXX XXX [3]
scribe6 XXX XXX
igks XXX XXX
saber2 XXX XXX
rs1.old XXX [4]
rs1.new XXX XXX [4]
prochart XXX XXX [4]
scheme XXX XXX [4]
Notes:
1. The README file is entirely inadequate. The top-level executable
doesn't run (apparently a shell script; it is only executable when it
should be readable/executable) . Proposals for what a README should
contain will be attached to the bottom of this report.
2. all xmath executables are in the top-level of the locker (i.e.,
there is no {rt,vax}bin organization.) There is also a core file
present in the top-level of the locker.
3. has neither vaxbin nor rtbin. does not currently run on RT
workstations.
4. does not run on the RT platform.
README FILES: what they should contain...
README files should have the following information: The full name of
the software, how to run it (from the /bin/csh), what the software's
status is (i.e., about to go away, about to be adopted, etc.), a
pointer to more documentation (either on-line or hardcopy), and an
e-mail address for bug reports. They should also be called
@i[README].
Most of the lockers above which have README files are missing some or
all of this information.
