summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 35 insertions, 7 deletions
diff --git a/README.md b/README.md
index 6d3e320..4cf9be4 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,39 @@
# cairomm
This library provides a C++ interface to cairo.
-See https://www.cairographics.org/cairomm/
+
+# General information
+
+Web site
+ - https://www.cairographics.org/cairomm/
+
+Download location
+ - https://www.cairographics.org/releases/
+
+Reference documentation
+ - https://www.cairographics.org/documentation/cairomm/reference/
+
+The reference documentation on the web describes the latest released version
+of cairomm, which is not ABI-compatible with the cairomm-1.0 ABI series.
+
+Tarballs contain reference documentation. In tarballs generated with Meson,
+see the untracked/docs/reference/html directory.
+
+Mailing list
+ - https://lists.cairographics.org/cgi-bin/mailman/listinfo/cairo
+
+Git repository
+ - https://gitlab.freedesktop.org/cairo/cairomm
+
+Bugs can be reported to
+ - https://gitlab.freedesktop.org/cairo/cairomm/-/issues
+
+Patches can be submitted to
+ - https://gitlab.freedesktop.org/cairo/cairomm/-/merge_requests
+
+# Building
+
+Whenever possible, you should use the official binary packages approved by the
+supplier of your operating system, such as your Linux distribution.
See the examples directory for example code.
@@ -11,14 +44,9 @@ Use pkg-config to discover the necessary include and linker arguments. For insta
If you build with Autotools, ideally you would use PKG_CHECK_MODULES in your
configure.ac file.
-# Building
-
-Whenever possible, you should use the official binary packages approved by the
-supplier of your operating system, such as your Linux distribution.
-
## Building on Windows
-See MSVC_NMake/MSVC-Builds.md
+See [MSVC-Builds.md](MSVC_NMake/MSVC-Builds.md)
## Building from a release tarball