Imported Upstream version 2.99.9 (LGPL3)
[platform/upstream/libsigc++.git] / README
1 libsigc++ -- The Typesafe Callback Framework for C++
2
3
4 General information:
5
6    libsigc++ implements a typesafe callback system for standard C++. It
7    allows you to define signals and to connect those signals to any
8    callback function, either global or a member function, regardless of
9    whether it is static or virtual.
10
11    libsigc++ is used by gtkmm to wrap the GTK+ signal system. It does not
12    depend on GTK+ or gtkmm.
13
14    Further information is available on the libsigc++ project home page:
15    http://libsigc.sourceforge.net/
16
17
18 License information:
19
20    Distribution of library and components is under the LGPL as listed in the
21    file COPYING. Examples and tests are Public Domain.
22
23
24 Contact information:
25    Maintainer: mailto: murrayc@murrayc.com
26    Maillist: mailto: libsigc-list@gnome.org
27    Homepage: http://libsigc.sourceforge.net
28    Online reference documentation: https://developer.gnome.org/libsigc++/unstable/
29    Download: http://ftp.gnome.org/pub/GNOME/sources/libsigc++/
30              https://download.gnome.org/sources/libsigc++/
31    Git: https://git.gnome.org/browse/libsigcplusplus/
32
33
34 Overview of the distribution:
35
36    docs/                             documentation on the signal system
37       docs/reference/                reference documentation
38    
39    examples/                         examples of various signal functions
40    
41    sigc++/                           source for library
42       sigc++/functors/               source for library (various functors)
43       sigc++/adaptors/               source for library (various adaptors)
44    
45    build/                            auxiliary files for building
46    
47    tests/                            programs testing and verifying proper behaviour
48    
49    MSVC_Net2017/                     project files for building the library with MSVC++ 2017
50
51
52 Compatibility:
53
54    Compatible compilers must support C++14, such as the decltype(auto) specifier.