Win a copy of Clojure in Action this week in the Clojure forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Readme .txt contents!

 
Vikas Sood
Ranch Hand
Posts: 109
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi friends,
My specs for readme.txt say:
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.

Apart from the src files from the application i also have javadoc files,do i need to document them as well or i will be ok by including index file for javadoc
Kindly comment
VikasSood
 
S. Ganapathy
Ranch Hand
Posts: 194
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Vikas,
Go through the instructions given to you carefully several times. That will clarify most of your questions/doubts.
My requirements does not say, I have to provide readme.txt
In packaging and submission section, it is clearly mentioned. Follow the instructions clearly.
Regards,
Ganapathy.
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 11833
181
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Vikas,
My README.txt file reads (in part):

My wording is a bit cheeky, but I didnt loose any marks for it
Regards, Andrew
 
I agree. Here's the link: http://aspose.com/file-tools
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic