From: Steve Brokenshire <sbrokenshire@xestia.co.uk>
Date: Sun, 22 Jan 2017 17:08:53 +0000 (+0000)
Subject: README: Added readme file
X-Git-Tag: release-0.02~19
X-Git-Url: http://Server1/repobrowser/?a=commitdiff_plain;h=7431600221af474357fdffcc0a93ae066cbfaad3;p=xestiacalendar%2F.git

README: Added readme file
---

diff --git a/README b/README
new file mode 100644
index 0000000..d3cf436
--- /dev/null
+++ b/README
@@ -0,0 +1,63 @@
+Xestia Calendar
+===============
+
+Xestia Calendar is a native CalDAV (RFC4791) calendar client which uses
+iCalendar 2.0 (RFC5545) with search, reminders and detailed calendar entry
+management.
+
+Xestia Calendar is developed by Xestia Software Devvelopment.
+
+Notice
+======
+
+As Xestia Calendar is in the first few versions, not everything may
+function correctly as expected or certain features which will appear
+in future versions.
+
+Bug Reporting
+=============
+
+To report a bug either use our Xestia Gelforn bug management system
+at https://gelforn.xestia.co.uk/xestiacalendar/ or send an email to
+bugs@xestia.co.uk with full information about the bug.
+
+Installation
+============
+
+For details on installing Xestia Calendar, read the INSTALL file.
+
+Unit Testing
+============
+
+Xestia Calendar has a unit testing application that allows the
+functions used within the application to be checked so that they
+work correctly.
+
+For more details, read the INSTALL file.
+
+Resources
+=========
+
+CalDAV RFC4791 specification
+https://tools.ietf.org/html/rfc4791
+
+iCalendar 2.0 RFC5545 specification
+https://tools.ietf.org/html/rfc5545
+
+Thanks
+======
+
+The developer of Xestia Calendar would like to thank the following for
+which without their libraries development would not be possible:
+
+wxWidgets
+https://www.wxwidgets.org/
+
+curl
+http://curl.haxx.se/libcurl/
+
+libxml2
+http://www.xmlsoft.org/
+
+iconv
+http://www.gnu.org/software/libiconv/