Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

submit questions

 
friso dejonge
Ranch Hand
Posts: 162
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi all,
The documentation mentions that the readme.txt must contain a.o.:
- the names of the files you have submitted, with a note of their location in the directory structure.
my question - does this mean i have to describe each and every file (java/class/gif/javadoc.hmtl), or will it be sufficient to display the directory structure and explain the use of the directories. because javadoc.html is a lot of files.
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Well it's a tough question, one that we will need a bunch of responses to to get an overall check.
I myself included every single file including the html files in my readme.txt.
Mark
 
Michael Morris
Ranch Hand
Posts: 3451
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
It was a pain in the posterior, but I did what Mark did. I listed the directory structure and tabbed in once for all files under each directory and tabbed once to the file type. For file type, I said something like: "javadoc generated html file". But, I lost a point on documentation, so who knows the best way?
Hope this helps,
Michael Morris
 
John Smith
Ranch Hand
Posts: 2937
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

my question - does this mean i have to describe each and every file (java/class/gif/javadoc.hmtl), or will it be sufficient to display the directory structure and explain the use of the directories. because javadoc.html is a lot of files.

I don't think you need to describe the javadoc files. If you list their location in the submitted archive, the purpose of these files will be self-explanatory. For example:
Files in the javadocs/ directory of the archive (java docs)
--------------------------------------------
allclasses-frame.html
deprecated-list.html
help-doc.html
index-all.html
index.html
overview-frame.html
overview-summary.html
...
Eugene.
 
Max Habibi
town drunk
( and author)
Sheriff
Posts: 4118
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
F,
I would suggest that you write a small program That is, it parses your directories for you, and lists all the files. That, if you need to make any modifications, then all you have to do is run your program again. You might want to have default descriptions for file types: for example

HTH,
M, author
The Sun Certified Java Developer Exam with J2SE 1.4
[ August 15, 2002: Message edited by: Max Habibi ]
 
Michael Morris
Ranch Hand
Posts: 3451
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I did something similar to what Max suggested and just modified the output where necessary. That way you'll be sure to list all the files in your submission.
Michal Morris
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic