Cleanup
[carla.git] / source / modules / lilv / sord-0.16.0 / INSTALL
blob9b54f51e01008c3aba03b0fda9aabf1cc0555f9d
1 Installation Instructions
2 =========================
4 Basic Installation
5 ------------------
7 Building this software requires only Python.  To install with default options:
9     ./waf configure
10     ./waf
11     ./waf install # or sudo ./waf install
13 Configuration Options
14 ---------------------
16 All supported options can be viewed using the command:
18     ./waf --help
20 Most options only need to be passed during the configure stage, for example:
22     ./waf configure --prefix=/usr
23     ./waf
24     ./waf install
26 Compiler Configuration
27 ----------------------
29 Several standard environment variables can be used to control how compilers are
30 invoked:
32  * CC:        Path to C compiler
33  * CFLAGS:    C compiler options
34  * CXX:       Path to C++ compiler
35  * CXXFLAGS:  C++ compiler options
36  * CPPFLAGS:  C preprocessor options
37  * LINKFLAGS: Linker options
39 Library Versioning
40 ------------------
42 This library uses semantic versioning <http://semver.org/>.
44 Several major versions can be installed in parallel.  The shared library name,
45 include directory, and pkg-config file are suffixed with the major version
46 number.  For example, a library named "foo" at version 1.x.y might install:
48     /usr/include/foo-1/foo/foo.h
49     /usr/lib/foo-1.so.1.x.y
50     /usr/lib/pkgconfig/foo-1.pc
52 Dependencies can check for the package "foo-1" with pkg-config.
54 Packaging
55 ---------
57 Everything can be installed to a specific root directory by passing a --destdir
58 option to the install stage (or setting the DESTDIR environment variable),
59 which adds a prefix to all install paths.  For example:
61     ./waf configure --prefix=/usr
62     ./waf
63     ./waf install --destdir=/tmp/package
65 Packages should allow parallel installation of several major versions.  For
66 example, the above would be packaged as "foo-1".