aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes the README.txt file Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "the README.txt file" Watch "the README.txt file" New topic
Author

the README.txt file

Doug Avery
Greenhorn

Joined: Nov 02, 2002
Posts: 7
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?
Stephane Weber
Ranch Hand

Joined: Mar 07, 2002
Posts: 110
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
(...)

Hope this helps,
Stephane
Detlev Beutner
Ranch Hand

Joined: Jul 13, 2001
Posts: 76
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
jay denzel
Ranch Hand

Joined: Sep 18, 2002
Posts: 57
I listed each and every file which was included in my submission jar file.
I got full points on documentation.
jay
-------
SCJP
SCJD
Doug Avery
Greenhorn

Joined: Nov 02, 2002
Posts: 7
Hoo boy! That really narrowed it down!
I did look at Simon's book today, and I believe he had a hand in the Dev exam at one point, so I think I'll follow Detlev's suggestion.
Thanks to all.
Detlev Beutner
Ranch Hand

Joined: Jul 13, 2001
Posts: 76
So, now I can add: Full points on documentation, my effort does not seem to be too bad
Hope it helps
Detlev
 
It is sorta covered in the JavaRanch Style Guide.
 
subject: the README.txt file