Granny's Programming Pearls
"inside of every large program is a small program struggling to get out"
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Readme.txt 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 "Readme.txt " Watch "Readme.txt " New topic


Baris Dere
Ranch Hand

Joined: Mar 23, 2004
Posts: 31
Hi guys,
I am almost done with my assingment. :-)
I have one more question. In my assignment its not asked to make a readme.txt file.
The executable JAR containing the programs. This must be called runme.jar.
The original, unchanged database file that was supplied to you. Note that you must keep a copy of the original database file supplied to you, and this must be the file you submit. The marking process will expect the exact same data without any changes.
A directory called code, containing all the source code and related parts of your project. You must create subdirectories within this to reflect your package structure and distribute your source files within those directories.
A file called version.txt. This must contain pure ASCII (not a word processor format) indicating the exact version of JDK you used, and the host platform you worked on.
A directory called docs, containing the following items at the top level:
This html file.
A subdirectory called javadoc, containing HTML/Javadoc documentation for all classes and interfaces you are submitting.
A file called choices.txt that containing pure ASCII (not a word processor format) text describing the significant design choices you made. Detail the problems you perceived, the issues surrounding them, your value judgments, and the decisions that you made. This document should also describe any uncertainties you had regarding the project, and the decisions you made when resolving them.
User documentation for the database server and the gui client. If your user documentation is online then you may omit this file. However, if the documentation is not online, you must provide either a single plain ASCII (not word processor format) text document, which must be called userguide.txt, or multiple HTML files which must all be accessible from a starting point document that must be called userguide.html.

But I often see peoples who make a readme.txt file. What to do now??
any suggestions??
thanks a lot ;-)
Baris Dere
Andrew Monkhouse
author and jackaroo
Marshal Commander

Joined: Mar 28, 2003
Posts: 11778

Hi Baris,
Follow your instructions .
I still refer to the readme.txt file in my posts because that was required in my instructions. But I had the Fly By Night Services assignment.
There are differences in the assignments (even between different releases of assignments with the same name), so whenever you see someone talking about something that doesnt match your instructions, you should assume that they are talking about a different assignment or version. And then think about whether what they are saying can be adapted to your instructions.
But no matter what, you must always follow your instructions.
Regards, Andrew

The Sun Certified Java Developer Exam with J2SE 5: paper version from Amazon, PDF from Apress, Online reference: Books 24x7 Personal blog
I agree. Here's the link:
subject: Readme.txt
It's not a secret anymore!