File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Documentation - Readme.txt

 
Najib Coutya
Greenhorn
Posts: 28
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
======
The names of the files you have submitted, with a note of their location in the directory structure, and a high level description of the purpose of each.
======
All,
I'm confused a bit about the above. I will submit jar files for the client and server and also all my .java files in appropriate directory structure, and obviously list them and explain about their position.
But what about all the .html files that the javadoc produced. Am I going to list them one by one or just where they are placed and their chief index.html file.
Please help.
Thank you
 
herve attia
Ranch Hand
Posts: 138
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
examiner needs to know where are located your different files :
For instance :
File/Directory Contents
------------- ---------
\db.db database file
\client.jar executable jar file for the FBN client
\server.jar executable jar file for the RMI server
\src source code ( including news classes, modified versions of supplied classes)
\suncertify Object code
\README.txt instructions file
\docs\index.html HTML/Javadoc documentation starting page: index.html
\docs\design.html HTML Design Document
 
Mark Spritzler
ranger
Sheriff
Posts: 17276
6
IntelliJ IDE Mac Spring
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Also if you do a search on "readme" on this forum, you will find lots of posts explaining what you need in there.
Mark
 
Najib Coutya
Greenhorn
Posts: 28
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Dear Herve and Mark,
Thanks a lot for your help. I did read postings about README before. I don't think I made myself clear enough.
I know that README should include where the design/ user help/ jars ... are.
but if we take the javadoc generated documentations, other than specifying where it is located, do you need to list EVERY SINGLE .html file that was produced by that documentation or just the mother directories of where the html files are? such as /doc/api
Cause just for my api I've got 40 html files!
 
herve attia
Ranch Hand
Posts: 138
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
just refer the index.html !!
 
Najib Coutya
Greenhorn
Posts: 28
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thank you I just wanted to double check.
Mark, I hope that Herve will get a share of the lottery too
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic