FAQ.md

@@ -5,15 +5,18 @@ Running OpenWalnut
 ------------------
 
 **Q.:** I have directly after program start a very high CPU load, is that normal?
+
 **A.:** You most probably turned off V-Sync in your graphics driver. To check this, press `'s'` in OpenWalnut to see the framerate. If it is larger than 60FPS, you need to turn on V-Sync. This is mainly due to the OpenSceneGraph which does all its stuff every frame and if rendered with 1000 FPS it consumes a lot of CPU. The NVidia driver provides the tool `nvidia-settings`. Start it and click on "OpenGL Settings" and activate V-Sync ("Sync to VBlank").
 
 **Q.:** When expanding the toolbar, some icons will be behind the GL widget and are inaccesible. What do I do?
+
 **A.:** This is known behaviour on MAC OSX. As a workaround you might place the toolbar vertical on the right side, not neighboured to the GL widget. Also you might have a look on issue \#89.
 
 Source Code Management
 ----------------------
 
 **Q.:** How do I get all files a user has ever touched and is in current revision?
+
 **A.:** This will only work if the environment variable USERNAME is present and your still have a mercurial repository and you're not on Windows and it will not follow across file renamings:
 
     for i in `LANG=C hg log -v -u $USERNAME | grep "^files:" | awk '{$1 =""; print }' | tr " " "\n" | sort | uniq | tr "\n" " "`; do find $i; done 2>/dev/null
@@ -22,11 +25,13 @@ Installing Prerequisites
 ------------------------
 
 **Q.:** There is no package libeigen3-dev in Ubuntu repositories.
+
 **A.:** Add a third party repository like this: `sudo add-apt-repository ppa:gaschler/rl/eigen3`, or download and extract Eigen3 archive, and let CMake know its location.
 
 ------------------------------------------------------------------------
 
 **Q.:** How do I remove installed Qt on Mac OSX with the python scripts located in `/Developer/Tools` so I can install the macports version?
+
 **A.:** Execute as root:
 
     sudo /Developer/Tools/uninstall-qt.py
@@ -35,11 +40,13 @@ Installing Prerequisites
 ------------------------------------------------------------------------
 
 **Q.:** What do I do when I get strange linker errors on MAC OSX while installing OSG and/or compiling OW?
+
 **A.:** Double and tripple cross check that macports has installed the right libraries for your architecture. For certain dylibs you might check this with `lipo -info filename.dylib` and `uname -a` gives you the architecture you are actually running.
 
 ------------------------------------------------------------------------
 
 **Q.:** There are modules which require teem but when I install teem some modules still do not compile. What am I missing?
+
 **A.:** Unfortunately, some of the teem features used in OpenWalnut are not yet available in any public release. You need to install teem from the SVN repository as described by Thomas Schultz [here](http://people.kyb.tuebingen.mpg.de/tschultz/sphinx/getting-started.html) and [here](http://people.kyb.tuebingen.mpg.de/tschultz/sphinx/home-glyph.html). Furthermore you need to set `Teem_DIR` appropriately using `ccmake`.
 
 Compiling and Linking
@@ -108,19 +115,23 @@ Compiling and Linking
 ------------------------------------------------------------------------
 
 **Q.:** Boost not found by cmake.
+
 **A.:** Set the environment variable `BOOST_ROOT` before issuing cmake or ccmake
 
 ------------------------------------------------------------------------
 
 **Q.:** Boost correctly found, but CMake wants to link against a other boost lib file
+
 **A.:** Check if you set the environment variable to some directory? Additionally you can set the right boost libs in `ccmake` by pressing `'t'` to toggle advanced mode and by entering the right libs manually
 
 ------------------------------------------------------------------------
 
 **Q.:** OpenSceneGraph not found.
+
 **A.:** As with Boost, you can set the `OSG_DIR` environment variable to help cmake find your OpenSceneGraph.
 
 ------------------------------------------------------------------------
 
 **Q.:** I have linker problems with OpenGL GLU.
+
 **A.:** You can add GLU in `src/qt4gui/CMakeLists.txt` in the line looking similar to this: `TARGET_LINK_LIBRARIES( ${BinName} ${OWCoreName} ${QT_LIBS} ${Boost_LIBRARIES} )`. Although this should not be needed as we do not use GLU, but on some Linux distributions, OpenSceneGraph seems to be linked wrong which causes other tools linking against it to require libGLU explicitly.