Merge commit 'debian/0.1_rc2-3' into debian

[roundcube.git] / README

diff --git a/README b/README
index e8e065e5fd48c763dd37229171e927d7a0ebe590..da1bd2e1ddf54300cac5d5664e3bc83a17bbd893 100644 (file)
--- a/README
+++ b/README
@@ -1,22 +1,13 @@
 RoundCube Webmail (http://roundcube.net)
 
-
-ATTENTION
----------
-This is just a snapshot of the current CVS repository and is NOT A STABLE
-version of RoundCube. There have been major changes since the latest release
-so please read the update instructions carefully. It's not recommended to
-replace an existing installation of RoundCube with this version. Also using
-a separate database or this installation is highly recommended.
-
-
 Introduction:
 -------------
 RoundCube Webmail is a browser-based multilingual IMAP client with an
-application-like user interface. It provides full functionality you expect from
-an e-mail client, including MIME support, address book, folder manipulation and
-message filters. RoundCube Webmail is written in PHP and requires the MySQL
-database. The user interface is fully skinnable using XHTML and CSS 2.
+application-like user interface. It provides full functionality you expect
+from an e-mail client, including MIME support, address book, folder manipulation,
+message searching and spell checking. RoundCube Webmail is written in PHP and
+requires the MySQL or Postgres database. The user interface is fully skinnable
+using XHTML and CSS 2.
 
 This project is meant to be a modern webmail solution which is easy to
 install/configure and that runs on a standard PHP plus MySQL or Postgres
@@ -28,6 +19,19 @@ The current development skin uses icons designed by Stephen Horlander and Kevin
 Gerich for Mozilla.org.
 
 
+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.
+
+
+Licensing:
+----------
+This product is distributed under the GPL. Please read through the file
+LICENSE for more information about our license.
+
+
 How it works:
 -------------
 The main authority for the RoundCube access is the IMAP server. If
@@ -41,42 +45,30 @@ will be allowed.
 
 Code Layout:
 ------------
-
 Basic sequence (index.php):
-  - index.php -> load_gui -> parse_template
+  - 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 parse_template
+  - 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
-
-
-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.
-
-
-Licensing: 
-----------
-This product is distributed under the GPL. Please read through the file
-LICENSE for more information about our license.
+  - provides common functions
 
 
 Contact:
 --------
 For any bug reports or feature requests please refer to the tracking system
-at sourceforge.net (http://sourceforge.net/tracker/?group_id=139281) or 
+at trac.roundcube.net (http://trac.roundcube.net/trac.cgi/report) or 
 subscribe to our mailing list. See http://www.roundcube.net/?p=mailinglists
 for details.
 
 You're always welcome to send a message to the project admin:
-roundcube@gmail.com
+hello@roundcube.net