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.TXT : file listing

 
Stephane Weber
Ranch Hand
Posts: 110
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 18944
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 101
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The first one should be sufficient.
 
Pete Lyons
Ranch Hand
Posts: 109
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic