Merge commit 'upstream/0.1'

[roundcube.git] / README

diff --git a/README b/README
index 40b5b975c2626ad368a3e85016b2be1815bac665..e06318cdb090e7780b4c553781c97224c849499b 100644 (file)
--- a/README
+++ b/README
@@ -24,10 +24,10 @@ Installation:
 -------------
 For detailed instructions on how to install RoundCube webmail on your server,
 please refer to the INSTALL document in the same directory as this document.
-Please carefully read the REQUIREMENTS section of the INSTALL instructions.
+Please carefully read the REQUIREMENTS section of the INSTALL instructions. 
 
 
-Licensing:
+Licensing: 
 ----------
 This product is distributed under the GPL. Please read through the file
 LICENSE for more information about our license.
@@ -44,14 +44,32 @@ already have a corresponding entry in the user's table (username and hostname)
 will be allowed.
 
 
+Code Layout:
+------------
+Basic sequence (index.php):
+  - index.php -> rcmail_load_gui -> new rcmail_template -> rcmail_template::send
+  - authentication details in this sequence
+
+Tasks
+  - index.php limits tasks to set list
+  - can see task in roundcube link when you mouse over it
+  - task templates stored in skins/default/templates
+  - templates "roundcube:" tokens that get replaced in rcmail_template class
+
+program/include/rcube_shared.inc
+  - defines rcube_html_page, class that lays out a roundcube web page
+  - defines form control classes
+  - provides common functions
+
+
 Contact:
 --------
 For any bug reports or feature requests please refer to the tracking system
-at trac.roundcube.net (http://trac.roundcube.net/trac.cgi/report) or 
-subscribe to our mailing list. See http://www.roundcube.net/?p=mailinglists
+at trac.roundcube.net (http://trac.roundcube.net/wiki/Howto_ReportIssues) or 
+subscribe to our mailing list. See http://roundcube.net/support
 for details.
 
 You're always welcome to send a message to the project admin:
-roundcube@gmail.com
+hello@roundcube.net