wood burning stoves*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Documentation - Readme.txt Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of Murach's Java Servlets and JSP this week in the Servlets forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Documentation - Readme.txt" Watch "Documentation - Readme.txt" New topic

Documentation - Readme.txt

Najib Coutya

Joined: Dec 18, 2001
Posts: 28
The names of the files you have submitted, with a note of their location in the directory structure, and a high level description of the purpose of each.
I'm confused a bit about the above. I will submit jar files for the client and server and also all my .java files in appropriate directory structure, and obviously list them and explain about their position.
But what about all the .html files that the javadoc produced. Am I going to list them one by one or just where they are placed and their chief index.html file.
Please help.
Thank you
herve attia
Ranch Hand

Joined: Sep 28, 2001
Posts: 138
examiner needs to know where are located your different files :
For instance :
File/Directory Contents
------------- ---------
\db.db database file
\client.jar executable jar file for the FBN client
\server.jar executable jar file for the RMI server
\src source code ( including news classes, modified versions of supplied classes)
\suncertify Object code
\README.txt instructions file
\docs\index.html HTML/Javadoc documentation starting page: index.html
\docs\design.html HTML Design Document
Mark Spritzler

Joined: Feb 05, 2001
Posts: 17249

Also if you do a search on "readme" on this forum, you will find lots of posts explaining what you need in there.

Perfect World Programming, LLC - Two Laptop Bag - Tube Organizer
How to Ask Questions the Smart Way FAQ
Najib Coutya

Joined: Dec 18, 2001
Posts: 28
Dear Herve and Mark,
Thanks a lot for your help. I did read postings about README before. I don't think I made myself clear enough.
I know that README should include where the design/ user help/ jars ... are.
but if we take the javadoc generated documentations, other than specifying where it is located, do you need to list EVERY SINGLE .html file that was produced by that documentation or just the mother directories of where the html files are? such as /doc/api
Cause just for my api I've got 40 html files!
herve attia
Ranch Hand

Joined: Sep 28, 2001
Posts: 138
just refer the index.html !!
Najib Coutya

Joined: Dec 18, 2001
Posts: 28
Thank you I just wanted to double check.
Mark, I hope that Herve will get a share of the lottery too
I agree. Here's the link: http://aspose.com/file-tools
subject: Documentation - Readme.txt
Similar Threads
Weblogic 6.0 Directory Structure
Zip file creation with directory suppression through an API
Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/log4j/Layout
any good free Java IDE + debugger