Merge branch 'release-1.2.2'

Author: Bondoki

CMakeLists.txt

@@ -34,7 +34,7 @@ SET (APPLICATION_CODENAME "${PROJECT_NAME}")
 SET (APPLICATION_COPYRIGHT_YEARS "2015")
 SET (APPLICATION_VERSION_MAJOR 1)
 SET (APPLICATION_VERSION_MINOR 2)
-SET (APPLICATION_VERSION_PATCH 1)
+SET (APPLICATION_VERSION_PATCH 2)
 SET (APPLICATION_VERSION_TYPE SNAPSHOT)
 SET (APPLICATION_VERSION_STRING "${APPLICATION_VERSION_MAJOR}.${APPLICATION_VERSION_MINOR}.${APPLICATION_VERSION_PATCH}-${APPLICATION_VERSION_TYPE}")
 SET (APPLICATION_ID "${APPLICATION_VENDOR_ID}.${PROJECT_NAME}")
@@ -49,9 +49,9 @@ SET (CMAKE_VERBOSE_MAKEFILE 0) # Use 1 for debugging, 0 for release
 # Check if LEMONADE_DIR is given
 #
 if (DEFINED LEMONADE_DIR)
-	message("LEMONADE_DIR set to "${LEMONADE_DIR})
+	message("LEMONADE_DIR set to " ${LEMONADE_DIR})
 else()
-    message(FATAL_ERROR "LEMONADE_DIR no set! Use -DLEMONADE_DIR=/path/to/LeMonADE/")
+    message( WARNING "LEMONADE_DIR no set! If the LeMonADE library was installed to a custom directory, use -DLEMONADE_DIR=/path/to/LeMonADE/ to set the correct search path")
 endif()
 
 #

INSTALL

@@ -23,6 +23,14 @@
  cmake -DLEMONADE_DIR=/path/to/LeMonADE/ ..
  make
 
+ ----------------------------------------------------
+ The option -DLEMONADE_DIR is necessary only if the 
+ LeMonADE library was installed to a non standard 
+ location. 
+ See https://github.com/LeMonADE-project/LeMonADE
+ for instructions on installing LeMonADE library.
+ ----------------------------------------------------
+ 
  #after successful build
  # rendering a test-bfm-file
  cd build/
@@ -44,8 +52,82 @@
  cmake -DLEMONADE_DIR=/path/to/LeMonADE/ ..
  make
 
+ ----------------------------------------------------
+ The option -DLEMONADE_DIR is necessary only if the 
+ LeMonADE library was installed to a non-standard 
+ location. 
+ See https://github.com/LeMonADE-project/LeMonADE
+ for instructions on installing LeMonADE library.
+ ----------------------------------------------------
+ 
  #after successful build
  # rendering a test-bfm-file
  cd build/
  ./LeMonADE-Viewer ../test.bfm
+ 
+ 
+== Troubleshooting ==
+
+* Problem: Build fails with linker error:
+
+  /usr/bin/ld: cannot find -lLeMonADE
+
+  Solution: 
+  LeMonADE is not properly installed, or the option -DLEMONADE_DIR was set incorrectly.
+  (a) Install the LeMonADE library to a default system path
+  (b) Install the LeMonADE library to a custom path and hand this path 
+      to the configure script, or cmake, depending on your choice of build method
+
+	  ./configure -DLEMONADE_DIR=/custom/install/path/to/LeMonADE
+	  make
+
+  For installation instructions to the LeMonADE library see https://github.com/LeMonADE-project/LeMonADE
+
+
+* Problem: On Ubuntu (tested with Ubuntu 14.04), build fails with linker error:
+
+  /usr/bin/ld: undefined reference to symbol 'dlsym@@GLIBC_2.2.5'
+
+  Solution: Add the following to src/LeMonADE-Viewer/CMakeLists.txt:
+  
+  Original line:
+
+	target_link_libraries(${APPLICATION_NAME} ${OPENGL_LIBRARIES} ${FLTK_LIBRARIES} Camera LineParser LeMonADE)
+
+  Changed line:
+  
+	target_link_libraries(${APPLICATION_NAME} ${OPENGL_LIBRARIES} ${FLTK_LIBRARIES} Camera LineParser LeMonADE dl)
+
+  Then, re-run the build instructions.
+  
+ 
+* Problem: On Ubuntu (tested with Ubuntu 14.04), build fails with linker error:
+
+  /usr/bin/ld: cannot find -lpng
+
+  Solution: Install development package for libpng12
+  
+  sudo apt-get install libpng12-dev
+
+
+* Problem: On Ubuntu (tested with Ubuntu 14.04), build fails with linker error:
+
+  /usr/bin/ld: cannot find -lz
+	
+  Solution: Install development package for zlib1g
+  
+  sudo apt-get install zlib1g-dev
+ 
+
+* Problem: On Ubuntu (tested with Ubuntu 14.04), build fails with linker error:
+ 
+  /usr/bin/ld: cannot find -lSOME_LIBRARY_NAME
+
+  where SOME_LIBRARY_NAME one of (jpeg,Xft,fontconfig,Xinerama)
+  
+  Solution: Install development package for libSOME_LIBRARY_NAME
+  
+  sudo apt-get install libSOME_LIBRARY_NAME-dev
+
+ 
 

README.md

@@ -48,6 +48,9 @@ For further details of LeMonADE-project see: [LeMonADE-project]
     cd build/
     ./LeMonADE-Viewer ../test.bfm
 ````
+## Troubleshooting
+
+* see INSTALL for solution of known issues
 
 
 ## License