If any environmental setup is required, do not just say what needs to be done; provide instructions on how to perform the setup.
I am working on my readme file and i wonder how much setup information that i need to provid.
Can i assume that "they" have a working java installed?
That rmiregistry is in the path?
In local mode, you only need to run the client application.
To do this, run the following command from a command window:
java -jar client.jar <<put db location here>>
java -jar client.jar db.db
(make sure that db.db is in the same directory)
To start the client:
java -jar client.jar <<put db location here>> <<put server location here>>
do I have to document how to install and execute the application in both Unix and Windows environment.
Also, it's said that
All submissions must be packaged in a JAR file.