From 4bac28966359c8278d058b50852e0ddb5565cd9a Mon Sep 17 00:00:00 2001 From: alecpl <alec@alec.pl> Date: Sat, 11 Jul 2009 17:53:11 -0400 Subject: [PATCH] - small code improvements --- README | 61 +++++++++--------------------- 1 files changed, 19 insertions(+), 42 deletions(-) diff --git a/README b/README index 417e59c..b40ab0f 100644 --- a/README +++ b/README @@ -4,23 +4,23 @@ ATTENTION --------- This is just a snapshot of the current SVN 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 +version of RoundCube. Unlike the latest release this version requires PHP 5 +and does not work on a webserver with PHP 4. 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. +a separate database for 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, +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 or Postgres 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 or Postgres +install/configure and that runs on a standard PHP plus MySQL, PostgreSQL or SQLite configuration. It includes open-source classes/libraries like PEAR (http://pear.php.net) and the IMAP wrapper from IlohaMail (http://www.ilohamail.org). @@ -29,55 +29,32 @@ Gerich for Mozilla.org. -How it works: -------------- -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 -> load_gui -> parse_template - - 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 - -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: +Licensing: ---------- This product is distributed under the GPL. Please read through the file LICENSE for more information about our license. +Contribution: +------------- +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: -------- 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 -- Gitblit v1.9.1