Add basic README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..9125b94
--- /dev/null
+++ b/README
@@ -0,0 +1,50 @@
+
+=======================
+
+0. AUTHENTICATION
+
+Authentication can be either with Kerberos or NTLM. If you have Kerberos
+set up (it's easy to do), then just having a valid ticket will suffice.
+
+If you want to use NTLM, you have to pass your userid and password to the
+scripts on the command line. NTLM is faster, especially for the first sync.
+
+=======================
+
+1. BUILD
+
+   $ make
+
+If it complains about missing dependencies, try (as root):
+
+   # yum install glib2-devel libical-devel libxml2-devel libsoup
+
+
+========================
+
+2. DISCOVER YOUR EWS URL
+
+   $ ./autodiscover.sh $EMAILADDRESS $USERNAME $PASSWORD
+
+This will attempt to connect to the 'autodiscover' server for your
+email domain, and retrieve the URL for your Exchange server. Note that
+you might have to use NTLM for this; Kerberos might not work.
+
+If successful, you should see an output line 'Found EWS URL:' with the URL
+for your Exchange server. You'll need it for the next command:
+
+========================
+
+3. SYNCHRONISE CALENDAR
+
+   $ ./syncfolder.sh $EWSURL $USERNAME $PASSWORD
+
+This should fetch all calendar items from the Exchange server and convert
+them into ical files in ~/ews-sync/ical/. It will also combine them all
+into a single ~/ews-sync/all.ics file. You can put this file on a web
+server and point Evolution at it as an 'On The Web' calendar, etc.
+
+Run this from cron (you'll want to be using Kerberos, not leaving your
+password lying around in scripts), and put the resulting file somewhere
+web-accessible, and you have an automatically-updating copy of your Exchange
+calendar which you can use from Linux.