summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMurray Cumming <murrayc@murrayc.com>2019-01-10 09:38:32 +0100
committerMurray Cumming <murrayc@murrayc.com>2019-01-10 09:42:08 +0100
commit8a0cb176cea4b5292484593bfafed682488f3e8e (patch)
tree7d3a5d03404cbab014613b6bc014f48d922dbbeb
parent8d7e37ed33abfaf2a886fd0727c5a4f34e0cccfd (diff)
downloadsigc++-8a0cb176cea4b5292484593bfafed682488f3e8e.tar.gz
README: Rename to README.md and reformat as markdown
And remove: - the description of the directory structure, which is outdated and not very useful. - the contact information section. There is no need to duplicate what is on the website, which we link to.
-rw-r--r--README56
-rw-r--r--README.md24
2 files changed, 24 insertions, 56 deletions
diff --git a/README b/README
deleted file mode 100644
index c2b3e51..0000000
--- a/README
+++ /dev/null
@@ -1,56 +0,0 @@
-libsigc++ -- The Typesafe Callback Framework for C++
-
-
-General information:
-
- libsigc++ implements a typesafe callback system for standard C++. It
- allows you to define signals and to connect those signals to any
- callback function, either global or a member function, regardless of
- whether it is static or virtual.
-
- libsigc++ is used by gtkmm to wrap the GTK+ signal system. It does not
- depend on GTK+ or gtkmm.
-
- Further information is available on the libsigc++ project home page:
- https://libsigcplusplus.github.io/libsigcplusplus/
-
-
-License information:
-
- Distribution of library and components is under the LGPL as listed in the
- file COPYING. Examples and tests are Public Domain.
-
-
-Contact information:
- Maintainer: mailto: murrayc@murrayc.com
- Maillist: mailto: libsigc-list@gnome.org
- Homepage: https://libsigcplusplus.github.io/libsigcplusplus/
- Online reference documentation: https://developer.gnome.org/libsigc++/unstable/
- Download: http://ftp.gnome.org/pub/GNOME/sources/libsigc++/
- https://download.gnome.org/sources/libsigc++/
- Git: https://github.com/libsigcplusplus/libsigcplusplus
- Bug reports: https://github.com/libsigcplusplus/libsigcplusplus/issues
-
-
-Overview of the distribution:
-
- docs/ documentation on the signal system
- docs/reference/ reference documentation
-
- examples/ examples of various signal functions
-
- sigc++/ source for library
- sigc++/functors/ source for library (various functors)
- sigc++/adaptors/ source for library (various adaptors)
-
- build/ auxiliary files for building
-
- tests/ programs testing and verifying proper behaviour
-
- MSVC_NMake/ NMake Makefiles for building the library with MSVC++ 2017 and later
-
-
-Compatibility:
-
- Compatible compilers must support C++17, such as the decltype(auto) specifier
- (from C++14) and std::invoke().
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..00ee806
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# libsigc++ -- The Typesafe Callback Framework for C++
+
+
+## Introduction
+
+libsigc++ implements a typesafe callback system for standard C++. It
+allows you to define signals and to connect those signals to any
+callback function, either global or a member function, regardless of
+whether it is static or virtual.
+
+libsigc++ is used by gtkmm to wrap the GTK+ signal system. It does not
+depend on GTK+ or gtkmm.
+
+See the [libsigc++ web site](https://libsigcplusplus.github.io/libsigcplusplus/)
+
+## License
+
+Distribution of library and components is under the LGPL as listed in the
+file COPYING. Examples and tests are Public Domain.
+
+# Compatibility
+
+Compatible compilers must support C++17, such as the decltype(auto) specifier
+(from C++14) and std::invoke().