source: git/INSTALL

Last change on this file was 02e7e56, checked in by Olly Betts <olly@…>, 3 months ago

Require at least FFmpeg >= 3.2

This was released in 2016 so everywhere should have at least this
version by now.

  • Property mode set to 100644
File size: 2.7 KB
Line 
1Installing Survex on Unix
2=========================
3
4If you are using Debian Linux or Ubuntu Linux or a distribution based
5on one of these, you will find it easier to install one of the
6prepackaged versions of Survex.
7
8Otherwise you'll need to build from source.  These instructions assume you're
9building from released tar archive - if you want to build from by checking out
10code from the git repository then you'll need additional tools installed,
11documented at: https://survex.com/cvs.html
12
13First of all, you need to make sure you have the required libraries installed.
14Where possible it's usually easier to install these using your Linux
15distribution's package manager.
16
17Note that C/C++ library packages are usually split into runtime and
18development, usually with similar names but with a -dev or -devel or similar
19suffix on the development one.  You'll need both installed to build Survex,
20but typically installing the development package will automatically install
21the corresponding runtime package too.
22
23* The main dependency is wxWidgets 3.2 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  The last release to support wxWidgets 3.0 was Survex 1.4.17.
31
32* You'll also need a working C and C++ compiler (with support for C99 and
33  C++11), and also the OpenGL development libraries if these aren't pulled in
34  by installing wxWidgets.
35
36* Version 7.2.0 or later of the PROJ library is needed for coordinate
37  conversion functionality.
38
39* Optionally, GDAL is used to support reading geodata files.  If not available
40  this feature is disabled.
41
42* Optionally, FFmpeg is used if available to implement Aven's movie export
43  feature.  You need libavcodec >= 57, which seems to correspond to FFmpeg
44  >= 3.2.
45
46Then at a shell prompt, unpack the source code, cd into the directory, and
47enter the following commands:
48
49./configure
50make
51make install
52
53By default 'make install' will try to install Survex under /usr/local,
54which means you'll probably need to become root for the 'make install' stage.
55If you use sudo to manage root access, then:
56
57sudo make install
58
59You can tell configure to install Survex elsewhere (e.g. under your home
60directory) like so:
61
62./configure --prefix=/home/olly/survex
63make
64make install
65
66If your wxWidgets installation isn't picked up automatically, or you
67have more than one version installed and want to select a particular
68one, then you can specify this like so:
69
70./configure WX_CONFIG=/opt/bin/wx-config
71
72You can use both --prefix and WX_CONFIG= if necessary.
Note: See TracBrowser for help on using the repository browser.