diff options
author | Michael McClurg <michael.mcclurg@outlook.com> | 2022-04-23 17:59:06 -0600 |
---|---|---|
committer | Allen Winter <allen.winter@kdab.com> | 2022-04-24 07:41:06 -0400 |
commit | 7f704bd9dd9e76f055456fec39b5d037bfdce697 (patch) | |
tree | 4b05a80254c3ddebee341452d1d3442c4029d5a1 /README.md | |
parent | 7ac64a1047cdc9786e5f9a163159a59c60e831db (diff) | |
download | libical-git-7f704bd9dd9e76f055456fec39b5d037bfdce697.tar.gz |
WIP: use README.md copy as doxygen mainpage
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 25 |
1 files changed, 14 insertions, 11 deletions
@@ -1,8 +1,8 @@ -# 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 @@ -31,8 +31,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 @@ -56,12 +56,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 @@ -86,10 +89,10 @@ In no particular order: * [GNOME Todo](https://wiki.gnome.org/Apps/Todo) * and more GNOME apps... - * KDE's [Kontact Suite](https://kontact.kde.org) - * [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... +* KDE's [Kontact Suite](https://kontact.kde.org) + * [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... ## Get Involved |