X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README;h=3af0a1f9d9f9af8e375b38e37c15e15b4d1aa0f6;hb=9d358bb749203c1c4cb278a01e51f79754aa643a;hp=e8e065e5fd48c763dd37229171e927d7a0ebe590;hpb=8d860c53f65e32cd32179b0a13775cea975a060a;p=roundcube.git diff --git a/README b/README index e8e065e..3af0a1f 100644 --- a/README +++ b/README @@ -1,82 +1,60 @@ -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. +Roundcube Webmail (http://roundcube.net) 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. - -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 -configuration. It includes open-source classes/libraries like PEAR -(http://pear.php.net) and the IMAP wrapper from IlohaMail -(http://www.ilohamail.org). - -The current development skin uses icons designed by Stephen Horlander and Kevin +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 management, +message searching and spell checking. Roundcube Webmail is written in PHP and +requires the MySQL, PostgreSQL or SQLite database. With its plugin API it is +easily extendable and the user interface is fully customizable using skins +which are pure XHTML and CSS 2. + +This project includes other open-source classes/libraries from PEAR +(http://pear.php.net), an IMAP library derived from IlohaMail +the TinyMCE rich text editor, Googiespell library for spell checking +or the HTML sanitizer by Frederic Motte. + +The current default skin uses icons designed by Stephen Horlander and Kevin Gerich for Mozilla.org. -How it works: +Installation: ------------- -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. - +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. -Code Layout: ------------- +If you're updating an older version of Roundcube please follow the steps +described in the UPGRADING file. -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 +Licensing: +---------- +This product is distributed under the GNU General Public License Version 2. +Please read through the file LICENSE for more information about our license. -program/include/rcube_shared.inc - - defines rcube_html_page, class that lays out a roundcube web page - - defines form control classes +Even if skins might contain some programming work, they are not considered +as a linked part of the application and therefore skins DO NOT fall under +the provisions of the GPL license. See the README file located in the skins +folder for details on the skin license. -Installation: +Contribution: ------------- -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. +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 sourceforge.net (http://sourceforge.net/tracker/?group_id=139281) 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