INSTALL

   1 Installing Survex on Unix
   2 =========================
   3
   4 If you are using Debian Linux or Ubuntu Linux or a distribution based
   5 on one of these, you will find it easier to install one of the
   6 prepackaged versions of Survex.
   7
   8 Otherwise you'll need to build from source.  First of all, you need to make
   9 sure you have the required libraries installed.  Where possible it's usually
  10 easier to install these using your Linux distribution's package manager.
  11 Note that C/C++ library packages are usually split into runtime and
  12 development, usually with similar names but with a -dev or -devel or similar
  13 suffix on the development one.  You'll need both to build Survex.
  14
  15 * The main dependency is wxWidgets 3.0 or later - if there's a suitable
  16   wxWidgets package for your platform, then just use that (note: library
  17   packages are usually split into runtime and development, usually with the
  18   same name but with a -dev or -devel or similar suffix on the latter.
  19   need both to build Survex).
  20
  21   Otherwise download the source code from https://wxwidgets.org/ and
  22   follow their build instructions.  IMPORTANT: You must enable OpenGL
  23   support by adding --with-opengl to the configure command line.
  24
  25 * You'll also need a working C and C++ compiler (with support for C++11), and
  26   also the OpenGL development libraries if these aren't pulled in by installing
  27   wxWidgets.
  28
  29 * Version 7.2.0 or later of the PROJ library is needed for coordinate
  30   conversion functionality.
  31
  32 * Optionally, FFMPEG is used if available to implement Aven's movie export
  33   feature.  If not available this feature is disabled.
  34
  35 Then at a shell prompt, unpack the source code, cd into the directory, and
  36 enter the following commands:
  37
  38 ./configure
  39 make
  40 make install
  41
  42 By default 'make install' will try to install Survex under /usr/local,
  43 which means you'll probably need to become root for the 'make install' stage.
  44 If you use sudo to manage root access, then:
  45
  46 sudo make install
  47
  48 You can tell configure to install Survex elsewhere (e.g. under your home
  49 directory) like so:
  50
  51 ./configure --prefix=/home/olly/survex
  52 make
  53 make install
  54
  55 If your wxWidgets installation isn't picked up automatically, or you
  56 have more than one version installed and want to select a particular
  57 one, then you can specify this like so:
  58
  59 ./configure WX_CONFIG=/opt/bin/wx-config
  60
  61 You can use both --prefix and WX_CONFIG= if necessary.