Browse Source

Update INSTALL file

git-svn-id: a436a847-0d15-0410-975c-d299462d15a1
David Robillard 6 years ago
  1. 27
  2. 29


@ -8,11 +8,7 @@ Building this software requires only Python. To install with default options:
./waf configure
./waf install
You may need to become root for the install stage, for example:
sudo ./waf install
./waf install # or sudo ./waf install
Configuration Options
@ -40,12 +36,20 @@ invoked:
* CPPFLAGS: C preprocessor options
* LINKFLAGS: Linker options
Installation Directories
Library Versioning
This library uses semantic versioning <>.
Several major versions can be installed in parallel. The shared library name,
include directory, and pkg-config file are suffixed with the major version
number. For example, a library named "foo" at version 1.x.y might install:
The --prefix option (or the PREFIX environment variable) can be used to change
the prefix which all files are installed under. There are also several options
allowing for more fine-tuned control, see the --help output for details.
Dependencies can check for the package "foo-1" with pkg-config.
@ -57,3 +61,6 @@ which adds a prefix to all install paths. For example:
./waf configure --prefix=/usr
./waf install --destdir=/tmp/package
Packages should allow parallel installation of several major versions. For
example, the above would be packaged as "foo-1".


@ -1,29 +0,0 @@
This library is designed to allow parallel installation of different major
versions. To facilitate this, the shared library name, include directory, and
pkg-config file are suffixed with the major version number of the library.
For example, if this library was named "foo" and at version 1.x.y:
Dependencies check for pkg-config name "foo-1" and will build
against a compatible version 1, regardless any other installed versions.
Packages should follow the same conventions as above, i.e. include the major
version (and only the major version) in the name of the package. Continuing the
example above, the package(s) would be named foo-1 and foo-1-dev. This way,
if/when version 2 comes out, it may be installed at the same time as version 1
without breaking anything.
Please do not create packages of this library that do not follow these
guidelines, you will break things and cause unnecessary headaches. Please do
not use any number as a suffix other than the actual major version number of the
upstream source package.
Because program and documentation names are not versioned, these should be
included in separate packages which may replace previous versions, since
there is little use in having parallel installations of them.