aspose file tools
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes README.TXT : file listing Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Head First Android this week in the Android forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "README.TXT : file listing" Watch "README.TXT : file listing" New topic
Author

README.TXT : file listing

Stephane Weber
Ranch Hand

Joined: Mar 07, 2002
Posts: 110
Hi, for the listing of files in the Readme.txt file, would the following be sufficient according to you ?

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

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
Ranch Hand

Joined: Nov 22, 2008
Posts: 18944
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
Ranch Hand

Joined: Oct 15, 2001
Posts: 101
The first one should be sufficient.
Pete Lyons
Ranch Hand

Joined: Aug 18, 2002
Posts: 109
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.
 
It is sorta covered in the JavaRanch Style Guide.
 
subject: README.TXT : file listing
 
It's not a secret anymore!