Skip to content

Commit

Permalink
Update installation errata
Browse files Browse the repository at this point in the history
  • Loading branch information
ndantam committed Sep 22, 2019
1 parent 2b1025c commit d497f92
Showing 1 changed file with 44 additions and 11 deletions.
55 changes: 44 additions & 11 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -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}
---------------------
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit d497f92

Please sign in to comment.