Win a copy of Testing JavaScript Applications this week in the HTML Pages with CSS and JavaScript forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Bear Bibeault
  • Ron McLeod
  • Jeanne Boyarsky
  • Paul Clapham
Sheriffs:
  • Tim Cooke
  • Liutauras Vilda
  • Junilu Lacar
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Tim Holloway
  • fred rosenberger
  • salvin francis
Bartenders:
  • Piet Souris
  • Frits Walraven
  • Carey Brown

README.TXT : file listing

 
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
 
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
 
Ranch Hand
Posts: 101
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The first one should be sufficient.
 
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.
 
And then we all jump out and yell "surprise! we got you this tiny ad!"
Building a Better World in your Backyard by Paul Wheaton and Shawn Klassen-Koop
https://coderanch.com/wiki/718759/books/Building-World-Backyard-Paul-Wheaton
    Bookmark Topic Watch Topic
  • New Topic