README.TXT : file listing

[Stephane Weber]

Hi, for the listing of files in the Readme.txt file, would the following be sufficient according to you ?

\classes - DIRECTORY containing the java class files
\javadoc - DIRECTORY containing the javadoc documentation
\src - DIRECTORY containing the java source files
\db.db - Original database file (given for the assignment)
\DesignChoices.txt - Document describing design choices made
\Devassnmt2.jar - The original jar file received from Sun's site for the assignment
\FBNClient.jar - The client application (executable jar file)
\FBNServer.jar - The server application (executable jar file)
\Readme.txt - This file

or should I also include something like this for each source file:

\src\suncertify - Main source directory
\src\suncertify\client - Directory containing source files for client application
\src\suncertify\db - Directory containing source files for database management
\src\suncertify\server - Directory containing source files for server application
\src\suncertify\client\ConnectionFactory.java - Class used for managing connections to database

Which would be ridiculous as they have all information in the javadoc, and I am telling them where to find that Javadoc ...
Thanks,
Stephane

[Anonymous]

Under the section Deliverables it's stated that the README.txt should contain the names and a high level description of the purpose of each file in the submitted jar file. I'm done with the Java files, but what about the output from javadoc ?
Cheers
Torgny

[christy smile]

The first one should be sufficient.

[Pete Lyons]

I listed each file, but used a generic description for the file types. Basically, I jarred up my files, put the output of jar tf assignment.jar into README.txt, and then did a search and replace for
.java
with
.java - Java source code file
and did similar things for the javadoc, classes, etc. I also sorted them so that the most interesting files were at the top of the list, and the repetitive BS was at the bottom.