This week's book giveaway is in the OO, Patterns, UML and Refactoring forum. We're giving away four copies of Refactoring for Software Design Smells: Managing Technical Debt and have Girish Suryanarayana, Ganesh Samarthyam & Tushar Sharma on-line! See this thread for details.
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
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.