$darkmode
Libical API Documentation 4.0 STABLE VERSION Visit the v3.0 documentation
/tmp/B.47ejeh9m/BUILD/libical-4.0.3-build/libical-4.0.3/docs/README.md
1 # Libical — an implementation of iCalendar protocols and data formats
2 
3 [![Github workflow](https://github.com/libical/libical/actions/workflows/build.yml/badge.svg)](https://github.com/libical/libical/actions)
4 [![Packaging status](https://repology.org/badge/tiny-repos/libical.svg)](https://repology.org/metapackage/libical)
5 
6 [Become a libical sponsor](https://github.com/sponsors/libical)
7 
8 ## About
9 
10 Libical — an implementation of iCalendar protocols and data formats
11 
12 Most of the code in here was written by Eric Busboom at the end
13 of the last millennium with help from dozens of contributors.
14 It is currently maintained by Allen Winter and the libical team
15 at <https://libical.github.io/libical>.
16 
17 Libical is an Open Source implementation of the iCalendar protocols
18 and protocol data units. The iCalendar specification describes how
19 calendar clients can communicate with calendar servers so users can
20 store their calendar data and arrange meetings with other users.
21 
22 Thanks to our [contributors](CONTRIBUTORS.md).
23 
24 ## RFCs
25 
26 See [RFC calendar standards](rfcs.md) for list of RFCs supported by this library.
27 
28 ## License
29 
30 The code and datafiles in this distribution are licensed under the
31 Mozilla Public License (MPL) v2.0. See <https://www.mozilla.org/MPL>
32 for a copy of this license.
33 
34 Alternately, you may use libical under the terms of the GNU Lesser
35 General Public License (LGPL) v2.1. See <https://www.gnu.org/licenses/lgpl-2.1.txt>
36 for a copy of this license.
37 
38 This dual license ensures that the library can be incorporated into
39 both proprietary code and GPL'd programs, and will benefit from improvements
40 made by programmers in both realms. We (the libical developers) will only
41 accept changes to this library if they are similarly dual-licensed.
42 
43 Some 3rdparty software with compatible licensing may be bundled with libcal.
44 Please refer to our [3rdparty list](3RDPARTY.md) to see the projects
45 included, along with their respective licenses.
46 
47 ## Building
48 
49 See the [Building Libical](INSTALL.md) instructions.
50 
51 ## Documentation
52 
53 For new releases please refer to our [Change Log](CHANGELOG.md) for a high-level
54 overview of changes since the previous version.
55 
56 See the [C API documentation](https://libical.github.io/libical/v4/apidocs/) and
57 [glibc API documentation](https://libical.github.io/libical/v4/libical-glib/).
58 
59 For a conceptual overview of the library, see [Using Libical](UsingLibical.md).
60 In the source distribution, you'll find more documentation in `docs/`, annotated
61 examples in `examples/` and test code in `src/test/` directories.
62 
63 For developers porting their code to libical version 4, please visit the
64 [Version 4 Migration Guide](MigrationGuide_to_4.md).
65 
66 ## Acknowledgments
67 
68 Portions of this distribution are (C) Copyright 1996 Apple Computer,Inc., AT&T Corp.,
69 International Business Machines Corporation and Siemens Rolm Communications Inc.
70 See [src/libicalvcal/README.TXT](src/libicalvcal/README.txt) for details.
71 
72 ## Libical Users
73 
74 In no particular order:
75 
76 * [Cyrus Email/Calendars/Contacts Server](https://www.cyrusimap.org)
77 * [syncEvolution](https://syncevolution.org)
78 * [Fantastical](https://flexibits.com/fantastical)
79 * GNOME's EDS (evolution-data-server) which serves data to:
80  * [Evolution](https://wiki.gnome.org/Apps/Evolution)
81  * [GNOME Calendar](https://wiki.gnome.org/Apps/Calendar)
82  * [GNOME Notes](https://wiki.gnome.org/Apps/Notes)
83  * [GNOME Todo](https://wiki.gnome.org/Apps/Todo)
84  * and more GNOME apps...
85 * KDE's [Kontact Suite](https://kontact.kde.org) including:
86  * [Akonadi framework](https://kontact.kde.org/components/akonadi.html)
87  * [KOrganizer calendar and scheduling component](https://kontact.kde.org/components/korganizer.html)
88  * and more KDE apps...
89 
90 ## Get Involved
91 
92 Watch the github project at <https://github.com/libical/libical>
93 
94 Follow discussions and announcements at
95  <https://github.com/libical/libical/discussions>
96 
97 Report bugs to our issue tracker at
98  <https://github.com/libical/libical/issues>