From d497f92c13a30fb6323aa4e7920377093f1b3e2b Mon Sep 17 00:00:00 2001 From: "Neil T. Dantam" Date: Sun, 22 Sep 2019 17:40:02 -0600 Subject: [PATCH] Update installation errata --- INSTALL | 55 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 44 insertions(+), 11 deletions(-) diff --git a/INSTALL b/INSTALL index 05d95a44..2c8e119d 100644 --- a/INSTALL +++ b/INSTALL @@ -9,7 +9,9 @@ Setup and Dependencies {#installation_setup} ====================== The following dependies are required or optional. Please see below -for the corresponding list of Debian and Ubuntu packages. +for the corresponding list of Debian and Ubuntu packages. Also, +please consult the errata notes below as some package versions have +missing features or bugs that require workarounds. Required Dependencies {#installation_setup_required} --------------------- @@ -81,19 +83,50 @@ tests. Now proceed to Quicklisp Setup below. -**Note 1**: Some versions of Blender in Ubuntu and Debian do not support - the COLLADA format for 3D meshes, so you may need to install - Blender manually in this case - (see https://www.blender.org/download/). -**Note 2**: The versions of SBCL in some distributions (e.g., SBCL 1.2.4 - in Debian Jessie) do not work with new versions of [CFFI] - (https://common-lisp.net/project/cffi/). In these cases, - you will need to install SBCL manually (see - http://www.sbcl.org/platform-table.html). +Installation Errata {#installation_errata} +------------------- + +Some package versions are missing features or contain minor bugs that +impede usage with amino. A listing of issues encountered so far is +below: + +### OMPL Missing Eigen dependency + +Version 1.4.2 of OMPL and the corresponding Debian/Ubuntu packages +contain are missing a required dependency on libeigen. To resolve, +you may need to do the following: + +1. Manually install libeigen: + + sudo apt-get install libeigen3-dev + +2. Manually add the eigen include directory to the ompl pkg-config + file. The ompl pkg-config file will typically be in + `/usr/lib/x86_64-linux-gnu/pkgconfig/ompl.pc`. The eigen include + path will typically be `/usr/include/eigen3`. Thus, you may change + the Cflags entry in `/usr/lib/x86_64-linux-gnu/pkgconfig/ompl.pc` + to: + + Cflags: -I${includedir} -I/usr/include/eigen3 + +### Blender Missing COLLADA Support + + Some versions of Blender in Ubuntu and Debian do not support the +COLLADA format for 3D meshes, so you may need to install Blender +manually in this case (see https://www.blender.org/download/). + +### SBCL and CFFI incompatibility + +The versions of SBCL in some distributions (e.g., SBCL 1.2.4 in Debian +Jessie) do not work with new versions of [CFFI] +(https://common-lisp.net/project/cffi/). In these cases, you will +need to install SBCL manually (see +http://www.sbcl.org/platform-table.html). + Mac OS X {#installation_setup_mac} ------------------------ +-------- ### Install Dependencies via Homebrew