diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 63 |
1 files changed, 43 insertions, 20 deletions
@@ -1,23 +1,34 @@ -Roundcube Webmail (http://roundcube.net) +Roundcube Webmail +================= +[roundcube.net](http://roundcube.net) + + +ATTENTION +--------- +This is just a snapshot of the current SVN repository and is **NOT A STABLE +version of Roundcube**. It's not recommended to replace an existing installation +of Roundcube with this version. Also using 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 management, +from an email 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 code is mainly written in PHP and is designed to run on a webserver. +It includes other open-source classes/libraries from [PEAR][pear], +an IMAP library derived from [IlohaMail][iloha] the [TinyMCE][tinymce] rich +text editor, [Googiespell][googiespell] library for spell checking or +the [WASHTML][washtml] sanitizer by Frederic Motte. -The current default skin uses icons designed by Stephen Horlander and Kevin -Gerich for Mozilla.org. +The current default skin uses icons designed by Stephen Horlander and [Kevin +Gerich][kmgerich] for Mozilla.org. INSTALLATION @@ -29,11 +40,11 @@ If you're updating an older version of Roundcube please follow the steps described in the UPGRADING file. -LICENSING ---------- +LICENSE +------- This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License (with exceptions -for skins & plugins) as published by the Free Software Foundation, +it under the terms of the GNU General Public License (**with exceptions +for skins & plugins**) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, @@ -42,7 +53,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License -along with this program. If not, see http://www.gnu.org/licenses/. +along with this program. If not, see [www.gnu.org/licenses/][gpl]. This file forms part of the Roundcube Webmail Software for which the following exception is added: Plugins and Skins which merely make @@ -55,8 +66,8 @@ version that will not be part of the Roundcube Webmail Software, you may remove the exception above and use this source code under the original version of the license. -For more details about licensing and the expections for skins and plugins -see http://roundcube.net/license +For more details about licensing and the exceptions for skins and plugins +see [roundcube.net/license][license] CONTRIBUTION @@ -64,15 +75,27 @@ 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 +For more information visit [roundcube.net/contribute][contrib] CONTACT ------- For any bug reports or feature requests please refer to the tracking system -at trac.roundcube.net (http://trac.roundcube.net/wiki/Howto_ReportIssues) -or subscribe to our mailing list. See http://roundcube.net/support -for details. +at [trac.roundcube.net][tracreport] or subscribe to our mailing list. +See [roundcube.net/support][support] for details. You're always welcome to send a message to the project admin: -hello@roundcube.net +hello(at)roundcube(dot)net + + +[pear]: http://pear.php.net +[iloha]: http://sourceforge.net/projects/ilohamail/ +[tinymce]: http://www.tinymce.com/ +[googiespell]: http://orangoo.com/labs/GoogieSpell/ +[washtml]: http://www.ubixis.com/washtml/ +[kmgerich]: http://kmgerich.com/ +[gpl]: http://www.gnu.org/licenses/ +[license]: http://roundcube.net/license +[contrib]: http://roundcube.net/contribute +[support]: http://roundcube.net/support +[tracreport]: http://trac.roundcube.net/wiki/Howto_ReportIssues |