Merge lp:~linda-alm/forssim/installDocUpdate into lp:forssim

[Linda A]

[Linda A (linda-alm)]

Updated installation document according to comments from Martin.

[Ulrika Dreifaldt (ulrika-dreifaldt)]

Looks good to me.

review: Approve

Unmerged revisions

328. By Linda Alm <lindaal@HiAlban> on 2009-08-20

Changed path to x3d examples. Removed part of FsWisdomSettings sectin, renamed section to FsWisdomSamples. Edited section Install dependencies.

=== modified file 'doc/04_Install_GNU.dox'
--- doc/04_Install_GNU.dox	2009-07-15 12:38:40 +0000
+++ doc/04_Install_GNU.dox	2009-08-20 13:18:43 +0000
@@ -12,7 +12,7 @@
 
 Currently, the three supported hardware/software configurations are:
  - Regular - a computer with decent Nvidia* graphics card. We recommend a Core2duo (or even Core2Quad) and Nvidia Geforce 8800 (or better)
- - HapticStation - a computer as above, with IEEE1394 (firewire) port plus a Sensable Omni haptic device
+ - HapticStation - a computer as above, with IEEE1394 (firewire) port plus a SensAble Omni haptic device
  - Alban - a computer with Core2Quad, Nvidia Quadro 3700, printer port, IEEE1394 (firewire), StereoGraphics emitter and shutter glasses plus Phantom Desktop haptic device
 
 * *) We only use Nvidia cards ourselves, and do not recommend use of ATI/AMD based cards due to infamous driver issues. If you have such card and it does work well for you, please contact us and we will perhaps change the recommendation. 
@@ -69,9 +69,7 @@
 cd forssim_dependencies
 ./setup_ubuntu
 \endcode
 
-Make sure we have \c /usr/local/lib as part of our library path:
 \code
-sudo sh -c "echo /usr/local/lib > /etc/ld.so.conf.d/local.conf"
 sudo ldconfig 
 \endcode
 
@@ -103,38 +101,26 @@
 
 That's it!
 
-\section FsWisdomSettings Editing the settings for FsWisdom
-You can try some sample test cases in the simulator but to be able to download them,
- you will need to have obtained a password from Forsslund Systems.
-
-At the moment you might need to start the program once to create the settings file. Type
-
-\code
-FsWisdom
-\endcode
-
-from any location in a terminal.
-
-Press cancel to exit the program.
-
-Open up the settings file
-\code
-gedit .config/Forsslund\ Systems\ AB/FsWisdom.conf
-\endcode
-
-and enter the password where it says
-
-\code
-[database]
-password=
-\endcode
-
-Save and close the settings file.
-
-Then you can start \c FsWisdom again. See chapter 10 for a description of the program, or 
+\section FsWisdomSamples Run samples in FsWisdom
+You can try some sample test cases in the simulator, but to be able to run the program and download them,
+ you will need to have obtained a user name and a password from Forsslund Systems.
+
+See chapter 10 for a description of the program, or 
 chapter 3 for some simple examples, 
 but make sure to continue the installation first if you need to install a haptic device.
 
+To start the program, type
+
+\code
+FsWisdom
+\endcode
+
+from any location in a terminal. 
+Enter user name and password. 
+Select <tt>Remove Wisdom Tooth Mouse v1</tt> and click <tt>Perform selected exercise</tt>.
+Use <tt>Alt-Tab</tt> to switch between the settings and simulation screen. While in the simulation screen you can use your mouse to drill. Press space to turn drill on/off and h to switch between drill/elevator.
+Move the drill in x/y-coordinates by pressing left mouse button and in x/z-coordinates by pressing  middle mouse button.
+
 
 \section GNUOmni HapticStation - Omni 
 If you do not have a SensAble Phantom device, ignore this section.
@@ -171,9 +157,9 @@
 
 Reboot the computer. Choose 2.6.22-14 in the boot loader (hit Esc in Ubuntu stage)
 
-\subsection InOH Install Open Haptics:
+\subsection InOH Install OpenHaptics:
 
-To install the proprietary drivers (that you need to acquire directly from Sensable), do the following.
+To install the proprietary drivers (that you need to acquire directly from SensAble, http://www.sensable.com/support-download-pdd.htm), do the following.
 Put the \c OpenHaptics_AE_LinuxV2.0.zip file in \c forssim_dependencies/
 
 \code
@@ -224,12 +210,12 @@
 Now try the haptic enabled simulation:
 
 \code
-cd forssim/models/one_cylinder/x3d   (to be moved)
+cd forssim/examples/x3d/
 QtH3DLoad drillable_cylinder.x3d 
 \endcode
        
 \section GNUAlban Alban Simulator - Phantom Desktop, pedals, stereo 
-If you do not have a Sensable Desktop device, ignore this section.
+If you do not have a SensAble Desktop device, ignore this section.
 
 \subsection Configure Nvidia drivers for Stereo glasses etc
 Press <tt>Ctrl-Alt-F1</tt> to enter a real console, then enter following:
@@ -250,7 +236,7 @@
 That should be all that's needed. 
 
 \subsubsection InstallPhantomDeviceDrivers Install Phantom Device Drivers with parallel port
-We will now configure parallel ports to be used with Sensable Phantom Desktop. The first part is to get the parallel port working. After that, the proprietary drivers are installed.
+We will now configure parallel ports to be used with SensAble Phantom Desktop. The first part is to get the parallel port working. After that, the proprietary drivers are installed.
  
 Add the following line at the end of  <tt>/etc/modprobe.d/options</tt>
 \code
@@ -280,7 +266,7 @@
 You need to logout and login again to enable the new group permission.
 
 
-To install the proprietary drivers (that you need to acquire directly from Sensable), do the following.
+To install the proprietary drivers (that you need to acquire directly from SensAble), do the following.
 Put the <tt>OpenHaptics_AE_LinuxV2.0.zip</tt> file in \c forssim_dependencies/
 
 \code
@@ -312,7 +298,7 @@
 Now try the haptic enabled simulation:
 
 \code
-cd forssim/models/one_cylinder/x3d   (to be moved)
+cd forssim/models/examples/x3d/
 QtH3DLoad drillable_cylinder.x3d 
 \endcode