This week's book giveaways are in the Refactoring and Agile forums.
We're giving away four copies each of Re-engineering Legacy Software and Docker in Action and have the authors on-line!
See this thread and this one for details.
Win a copy of Re-engineering Legacy Software this week in the Refactoring forum
or Docker in Action in the Agile forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

User Documentation

 
Chandu onwards
Greenhorn
Posts: 13
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
currently i have my user documentation present in the readme.txt file is this ok?, or do i need to supply a user documentation in a different file, if so plse let me know where do i need to specify the userDocumentation file name.
thanks,
onwards
[ January 03, 2003: Message edited by: Mark Spritzler ]
 
John Smith
Ranch Hand
Posts: 2937
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

currently i have my user documentation present in the readme.txt file is this ok?, or do i need to supply a user documentation in a different file, if so plse let me know where do i need to specify the userDocumentation file name.

Yes, user documentation must be in a separate file. Note that the contents and format of readme.txt is strictly specified, while user doc is up to you (including the name of that file).
Eugene.
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I edited the topic title to be Proper Case. Having All Upper Case is like Yelling.
Mark
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic