Skip to content

Commit 014bdf6

Browse files
committed
README.md: Add some build hints
This fixes issue #18: #18 Note that this file should not duplicate too much from the website. Information should be on the website or in the README.md, but rarely in both places.
1 parent 8a0cb17 commit 014bdf6

File tree

1 file changed

+54
-3
lines changed

1 file changed

+54
-3
lines changed

README.md

Lines changed: 54 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# libsigc++ -- The Typesafe Callback Framework for C++
2-
1+
# libsigc++ : The Typesafe Callback Framework for C++
32

43
## Introduction
54

@@ -18,7 +17,59 @@ See the [libsigc++ web site](https://libsigcplusplus.github.io/libsigcplusplus/)
1817
Distribution of library and components is under the LGPL as listed in the
1918
file COPYING. Examples and tests are Public Domain.
2019

21-
# Compatibility
20+
## Compatibility
2221

2322
Compatible compilers must support C++17, such as the decltype(auto) specifier
2423
(from C++14) and std::invoke().
24+
25+
## Build
26+
27+
Whenever possible, you should use the official binary packages approved by the
28+
supplier of your operating system, such as your Linux distribution. For
29+
instance, Ubuntu Linux, Debian Linux and Fedora Linux have official libsigc++
30+
packages.
31+
32+
## Building from a release tarball
33+
34+
Building from the [libsigc++ release tarball](https://github.com/libsigcplusplus/libsigcplusplus/releases) is easier than building from git.
35+
36+
For instance:
37+
```sh
38+
$ ./configure --prefix=/usr/local
39+
$ make
40+
$ make install
41+
```
42+
43+
## Building from git
44+
45+
Building from git can be difficult so you should prefer building from a release
46+
tarball unless you need to work on the libsigc++ code itself.
47+
48+
To build from git you may use either the autotools build (used by most
49+
developers) or CMake (should work too).
50+
51+
### Building from git with autotools
52+
53+
You must have autotools properly installed (autoconf, automake, etc) and you
54+
will also need [mm-common](https://gitlab.gnome.org/GNOME/mm-common/).
55+
56+
```sh
57+
$ ./autogen.sh --prefix=/usr/local
58+
$ make
59+
$ make check
60+
```
61+
62+
### Building from git with CMake
63+
64+
The CMake build is not used very often by the libsigc++ developers, but it
65+
should work, and we would welcome improvements.
66+
67+
For instance:
68+
69+
```sh
70+
$ mkdir libsigcplusplus_build
71+
$ cd libsigcplusplus_build
72+
$ cmake path/to/libsigcplusplus
73+
$ make
74+
```
75+

0 commit comments

Comments
 (0)