Merge branch 'mcclurgm-readme-mainpage'

3 files changed, 12 insertions, 50 deletions

diff --git a/README.md b/README.md
index 49a67fe2..03a3a78c 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-# Libical
+# Libical — an implementation of iCalendar protocols and data formats {#mainpage}
 
 [![Appveyor status](https://ci.appveyor.com/api/projects/status/github/libical/libical?branch=master?svg=true)](https://ci.appveyor.com/api/projects/status/github/libical/libical)
 [![Packaging status](https://repology.org/badge/tiny-repos/libical.svg)](https://repology.org/metapackage/libical)
 
-## Introduction
+## About
 
 Libical — an implementation of iCalendar protocols and data formats
 
@@ -32,8 +32,8 @@ plus the iCalendar iMIP protocol in [RFC6047][].
 [RFC9074]: https://tools.ietf.org/html/rfc9074
 
 The libical-glib API is currently unstable and can change with any release.
-Until it is considered stable, there should be defined LIBICAL_GLIB_UNSTABLE_API=1
-before including <libical-glib/libical-glib.h>, to indicate that the library user
+Until it is considered stable, there should be defined `LIBICAL_GLIB_UNSTABLE_API=1`
+before including `<libical-glib/libical-glib.h>`, to indicate that the library user
 is aware of it and is prepared to change the calls anytime.
 
 ## License
@@ -57,12 +57,15 @@ See the top-level [Install.txt](Install.txt) file.
 
 ## Documentation
 
-There is rudimentary, unfinished documentation in the `doc/` directory,
-see [UsingLibical.md](doc/UsingLibical.md)
+Documentation is hosted at <https://libical.github.io/libical/apidocs/>.
+
+For a conceptual overview of the library, see [UsingLibical.md](@ref UsingLibical).
+There is other rudimentary, unfinished documentation in the `doc/` directory of
+the source distribution,
 and annotated examples in `examples/` and the test code in `src/test/`.
 
 Additionally, progress is underway to add API documentation,
-which is available [here](https://libical.github.io/libical/apidocs/index.html)
+which is available at the apidocs site.
 
 ## Acknowledgments
 
@@ -85,8 +88,7 @@ In no particular order:
   * [GNOME Notes](https://wiki.gnome.org/Apps/Notes)
   * [GNOME Todo](https://wiki.gnome.org/Apps/Todo)
   * and more GNOME apps...
-* KDE:
-  * [Kontact](https://kontact.kde.org):
+* KDE's [Kontact Suite](https://kontact.kde.org) including:
   * [Akonadi framework](https://kontact.kde.org/components/akonadi.html)
   * [KOrganizer calendar and scheduling component](https://kontact.kde.org/components/korganizer.html)
   * and more KDE apps...
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 68b42cac..f2cc4d9c 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -18,7 +18,7 @@ set_package_properties(Doxygen PROPERTIES
   PURPOSE "Needed to build the API documentation."
 )
 if(DOXYGEN_FOUND)
-  file(GLOB _dox_deps *.dox *.html *.md)
+  file(GLOB _dox_deps *.dox *.html *.md ${CMAKE_SOURCE_DIR}/README.md)
   file(GLOB _all_hdrs
     ${CMAKE_SOURCE_DIR}/src/libical/*.h
     ${CMAKE_SOURCE_DIR}/src/libical/*.c
diff --git a/doc/Mainpage.dox b/doc/Mainpage.dox
deleted file mode 100644
index 28b43b76..00000000
--- a/doc/Mainpage.dox
+++ /dev/null
@@ -1,40 +0,0 @@
-/*!
-@mainpage Libical - an implementation of iCalendar protocols and data formats
-
-@section about About
-
-Libical is an Open Source implementation of the iCalendar protocols
-and protocol data units. The iCalendar specification describes how
-calendar clients can communicate with calendar servers so users can
-store their calendar data and arrange meetings with other users.
-
-Libical implements RFC5545, RFC5546, RFC7529;
-the CalDav scheduling extensions in RFC6638;
-iCalendar extensions in RFC7986, RFC9073, RFC9074;
-plus the iCalendar iMIP protocol in RFC6047.
-
-For a conceptual overview of the library, see 
-[Using Libical](@ref UsingLibical).
-
-@section license License
-
-The code and datafiles in this distribution are licensed under the
-Mozilla Public License (MPL) v2.0. See https://www.mozilla.org/MPL
-for a copy of the license.
-
-Alternately, you may use libical under the terms of the GNU Library
-General Public License (LGPL) v2.1. See https://www.gnu.org/licenses/lgpl-2.1.txt
-for a copy of the license.
-
-This dual license ensures that the library can be incorporated into
-both proprietary code and GPL'd programs, and will benefit from improvements
-made by programmers in both realms. I will only accept changes into
-my version of the library if they are similarly dual-licensed.
-
-@section acknowledgements Acknowledgments
-
-Portions of this distribution are (C) Copyright 1996 Apple Computer,
-Inc., AT&T Corp., International Business Machines Corporation and
-Siemens Rolm Communications Inc. See src/libicalvcal/README.TXT for details.
-
-*/