From 48f5e6597eedc5e12abcdf2ab12fe8237596613c Mon Sep 17 00:00:00 2001 From: thomascube Date: Sat, 20 Sep 2008 14:22:40 +0000 Subject: Remove code documentation from README --- README | 39 +++++++++------------------------------ 1 file changed, 9 insertions(+), 30 deletions(-) diff --git a/README b/README index 8a39fc927..45a070fbe 100644 --- a/README +++ b/README @@ -14,10 +14,10 @@ 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, +from an e-mail client, including MIME support, address book, folder management, message searching and spell checking. RoundCube Webmail is written in PHP and -requires the MySQL, PostgreSQL or SQLite database. The user interface is fully skinnable -using XHTML and CSS 2. +requires the MySQL, PostgreSQL or SQLite 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, PostgreSQL or SQLite @@ -35,39 +35,18 @@ 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: +Licensing: ---------- This product is distributed under the GPL. Please read through the file LICENSE for more information about our license. -How it works: +Contribution: ------------- -The main authority for the RoundCube access is the IMAP server. If -'auto_create_user' is set to TRUE in config/main.inc.php a new record in the -user table will be created once the IMAP login succeeded. This user record does -not store a password, it's just used to assign identities, contacts and cache -records. If you have 'auto_create_user' set to FALSE only IMAP logins which -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 +Want to help make RoundCube the best webmail solution ever? +RoundCube is open source software. Our developers and contributors all +are volunteers and we're always looking for new additions and resources. +For more information visit http://roundcube.net/contribute Contact: -- cgit v1.2.3