Win a copy of Design for the Mind this week in the Design forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

User guide must include installation?

 
Baris Dere
Ranch Hand
Posts: 31
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi guys,

I am writing the userguide.html file. But must I also write how to install the JRE and set path like so:


1.1 Installation the Database Server

To install the Database Server you have to need Java Runtime Environment. You can download the Java Runtime Environment from the site http://java.sun.com.

Once you have installed the Java Runtime Environment you are ready to start the database server.

1.2 Starting the Database Server

When you unpack the project.jar to a directory, you will find see a runme.jar file. This is the file that you must to execute to. When starting the server you have to do as next:

java -jar runme.jar server

When it can't find the runme.jar this means that runme.jar file is not in your current directory, so you must give the gie the whole path of the file. Just so (Example: runme.jar is in your C:\Windows directory):

java -jar "c:\Windows\runme.jar" server

When it can't find "java.exe" you have to set the PATH environment of the system to your Java Runrime Environment directory. Like so:

set path="c:\jre\bin\"

If you try now, it will start the server.


Or knows the examiner how to do this all?

Thanks

Baris
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 11865
194
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Baris,

I think it is a good idea to give basic instructions like these. We should write the instructions as though the person reading them knows nothing about Java / the assignment. (The alternative is to assume that the examiner is an expert, but then you should not need any instructions - since instructions are required it negates that argument ).

Regards, Andrew
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic