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

Readme must list every file?

 
Gennady Shapiro
Ranch Hand
Posts: 196
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The requiremnts state that your Readme.txt must list every file in submission.
Does that include HTML files generated by javadoc? or even every .java or .clss file?
listing all these files isnt very smart. Would it be enough to list top level directories for those files?
Thanks
 
Trevor Dunn
Ranch Hand
Posts: 84
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I think you take that requirement with a grain of salt. I got 20/20 on documentation and I only listed my java files, readme, design choices and user documentation.
Trevor
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Now you tell me. That was the biggest pain was trying to list everything. So I of course did. DOH!
Mark
 
Gennady Shapiro
Ranch Hand
Posts: 196
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Trevor,
just to make sure:
you listed every Java Source File, correct?
Thanks
 
Peter Crowley
Greenhorn
Posts: 14
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I would think that if you just list the classes that you created or are using, then that should cover both source files and class files. It seems rediculous to list the source files and then list the class files and saying "This is the class file generated from the source file" every time.
Just my thoughts,
-Peter Crowley
 
Trevor Dunn
Ranch Hand
Posts: 84
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yes I listed all my source files but not my class files.
Trevor
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic