# HG changeset patch # User Paul Boddie # Date 1446419022 -3600 # Node ID 471f15d906d4a1c6661a0bf93e52237980b4eda5 # Parent 299473933becd91add3834a4d93753ebcb18908e Updated the README.txt file, removing superfluous notes and adding information about copyright and licensing, plus information about packaging the wiki pages. diff -r 299473933bec -r 471f15d906d4 README.txt --- a/README.txt Sun Nov 01 23:58:21 2015 +0100 +++ b/README.txt Mon Nov 02 00:03:42 2015 +0100 @@ -1,11 +1,11 @@ -imip-agent -========== +Introduction +============ -This software implements an agent that can interpret e-mail messages -containing calendar information, maintain availability records for scheduling -participants, act on behalf of resources and other entities that need to -participate in scheduling, and support user interfaces for end-users whose -e-mail programs do not understand calendar data. +The imip-agent software implements agent programs that can interpret e-mail +messages containing calendar information, maintain availability records for +scheduling participants, act on behalf of resources and other entities that +need to participate in scheduling, and support user interfaces for end-users +whose e-mail programs do not understand calendar data. Getting Started =============== @@ -16,29 +16,33 @@ See: docs/wiki/GettingStarted -Configuring Mail Systems for Mail Recipients -============================================ - -The software should operate independently of the way mail recipients are -identified in any given mail system, and thus does not dictate things such as -routing or account querying. However, example configuration files are provided -that demonstrate the use of various techniques to identify mail recipients. - -Naturally, these recipient identification configuration examples can be -disregarded in favour of other ways of defining mail recipients, subject to -the needs of any given environment. - -See: docs/wiki/MailIntegration -See: docs/wiki/MailIntegration--LDAP -See: docs/wiki/MailIntegration--Simple - -Configuring Mail Systems for Mail Delivery +Contact, Copyright and Licence Information ========================================== -The agent software assumes that delivery of mail to recipients may be -performed either using local SMTP or by using LMTP to a suitable mailbox -provider. +See the following Web pages for more information about this work: + +http://hgweb.boddie.org.uk/imip-agent + +The author can be contacted at the following e-mail address: + +paul@boddie.org.uk + +Copyright and licence information can be found in the docs directory - see +docs/COPYING.txt and docs/gpl-3.0.txt for more information. + +Generating the Wiki Pages +========================= -See: docs/wiki/MailIntegration -See: docs/wiki/MailIntegration--LMTP -See: docs/wiki/MailIntegration--LocalSMTP +The docs/make_pages.sh script generates a page package for MoinMoin. + +Currently, the wiki pages require the following extensions: + +ImprovedTableParser https://moinmo.in/ParserMarket/ImprovedTableParser + +MoinSupport http://hgweb.boddie.org.uk/MoinSupport + +GraphvizParser https://moinmo.in/ParserMarket/graphviz + +The GraphvizParser requires diagram-tools for the notugly.xsl stylesheet, +although a copy of the stylesheet is provided in the GraphvizParser +distribution for convenience.