• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

question about readme document

 
xiaoma wang
Ranch Hand
Posts: 74
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi, everybody:
i am writting the readme.txt and a bit confused: Sun requires that "the names of files you have submitted, with a note of their location in the directory, and a high level description of the purpose of each". I need to list the location of every file, such as every class source code file? It seems to be unnecessary, but I am not sure. U guys have some idea?
Thanks!
Xiaoma Wang
 
Adam Roberts
Ranch Hand
Posts: 71
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I just made a quick and general list, nothing huge. I put a note in like .class = complied files in server/client.jar and .java = source in source.jar and just listed the names of the classes/source files.
I doubt they'll freak out if you generalize or forget to mention a file
Hope that helps
 
xiaoma wang
Ranch Hand
Posts: 74
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi, Adam:
You clear me out and i will try to make a src.jar and docs.jar to contain the source code of all the
classes and interfaces and javadoc doc... That makes me easy to describe the flie and its location. Thank you very much!
Xiaoma Wang
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic