source: git/INSTALL @ cbc9803a

debug-cidebug-ci-sanitisersfaster-cavernlogwalls-datawalls-data-hanging-as-warning
Last change on this file since cbc9803a was cbc9803a, checked in by Olly Betts <olly@…>, 9 months ago

INSTALL: Link to building from git instructions

Reported by Andrew Northall.

Closes: https://github.com/ojwb/survex/pull/13

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