source: git/INSTALL

Last change on this file was b58dbb4, checked in by Olly Betts <olly@…>, 8 weeks ago

INSTALL: Document requirement for a C99 compiler

We made this a requirement in 1.4.2, but only noted it in NEWS.

  • Property mode set to 100644
File size: 2.5 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.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
40Then at a shell prompt, unpack the source code, cd into the directory, and
41enter the following commands:
42
43./configure
44make
45make install
46
47By default 'make install' will try to install Survex under /usr/local,
48which means you'll probably need to become root for the 'make install' stage.
49If you use sudo to manage root access, then:
50
51sudo make install
52
53You can tell configure to install Survex elsewhere (e.g. under your home
54directory) like so:
55
56./configure --prefix=/home/olly/survex
57make
58make install
59
60If your wxWidgets installation isn't picked up automatically, or you
61have more than one version installed and want to select a particular
62one, then you can specify this like so:
63
64./configure WX_CONFIG=/opt/bin/wx-config
65
66You can use both --prefix and WX_CONFIG= if necessary.
Note: See TracBrowser for help on using the repository browser.