Win a copy of The Java Performance Companion this week in the Performance forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

READ_ME.txt file

 
Matt Ghiold
Ranch Hand
Posts: 213
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hey guys,
In my readme.txt file I have included example command lines on a windows platform, should I do the same for a Unix/Linux platform, or is it not needed?
Thoughts?
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Is there a difference in you command line between Windows and UNIX?
Either way, part of your readme.txt is to tell them the OS you built it on. I don't think they can grade you down becuase you don't know how to use UNIX, so I think the Windows command like itself should be fine. Did that make sense?
Hope that helps.
Mark
 
Matt Ghiold
Ranch Hand
Posts: 213
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The only difference in my command lines is if you want to move the help files around, so instead of using an xcopy in windows your would use a cp -r in unix/linux.
I guess im ok, 1 more battery of tests and I guess it's time to submit and see what happens
Thanks for advice as always Mark!
 
Bernhard Woditschka
Ranch Hand
Posts: 89
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
My $0.02 are to simply ommit things that can go wrong and are not absolutely neccessary
The only difference in my command lines is if you want to move the help files around

I just assume they are capeable to move files around on their OS so I don't mention that at all.
Bern
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic