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