The project instructions describe how to package your submission, and list the contents of your README.txt file. In it they say you need to include a list of the files you submit, their locations in the directory structure, and a description of their purpose. Do they mean we are to list each and every source, class and doc file, or do they really mean list files such as your Design Decision file, your client.jar file, etc, and then merely refer to all the source files, class files, etc., as a whole by naming the directory they are in?
I would say just between the two is great ;-) Here is the listing I put in my README.TXT:
6. File listing Here are the files present in this archive. \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 - 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 Source files complete listing: \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\db\BookException.java - Please see JAVADOC for description \src\suncertify\db\Data.java - Please see JAVADOC for description \src\suncertify\db\DatabaseException.java - Please see JAVADOC for description \src\suncertify\db\DataInfo.java - Please see JAVADOC for description \src\suncertify\db\DataInterface.java - Please see JAVADOC for description \src\suncertify\db\FieldInfo.java - Please see JAVADOC for description (...)
In Simon Roberts (et al) "Complete Java 2 Certification Study Guide", he gives an example of such a readme.txt. I also asked myself if I should add each and every souce file (and the doc-files...) and I could not realize any sense in that (because the JavaDoc-Files are the description for the source files and should not need to be described themselves). In Simons example, only the files in the root are described, maybe the sub-dir's in the root, too (I don't have the book at hand). I have placed the a jar with the complete sources, a jar with the doc, two jar's for client and server (compiled) into the jar sent. So I have described all files in my jar I cannot say how this effort was honorated, for I'm waiting for the results for 3 weeks, 5 days (hopefully getting the results within the next two days). Hope it helps Detlev