Aleksander Machniak
2012-05-10 8253e7d245b03a2bfd5b51573e5d1024e45022ce
commit | author | age
217b80 1 Roundcube Webmail 
TB 2 =================
3 [roundcube.net](http://roundcube.net)
4
5
6 ATTENTION
7 ---------
dac31d 8 This is just a snapshot from the GIT repository and is **NOT A STABLE
217b80 9 version of Roundcube**. It's not recommended to replace an existing installation
TB 10 of Roundcube with this version. Also using a separate database for this
11 installation is highly recommended.
30233b 12
977a29 13
7fe381 14 INTRODUCTION
T 15 ------------
233622 16 Roundcube Webmail is a browser-based multilingual IMAP client with an
635831 17 application-like user interface. It provides full functionality you expect
217b80 18 from an email client, including MIME support, address book, folder management,
233622 19 message searching and spell checking. Roundcube Webmail is written in PHP and
T 20 requires the MySQL, PostgreSQL or SQLite database. With its plugin API it is
21 easily extendable and the user interface is fully customizable using skins
22 which are pure XHTML and CSS 2.
30233b 23
217b80 24 The code is mainly written in PHP and is designed to run on a webserver.
TB 25 It includes other open-source classes/libraries from [PEAR][pear],
26 an IMAP library derived from [IlohaMail][iloha] the [TinyMCE][tinymce] rich
27 text editor, [Googiespell][googiespell] library for spell checking or
28 the [WASHTML][washtml] sanitizer by Frederic Motte.
30233b 29
217b80 30 The current default skin uses icons designed by Stephen Horlander and [Kevin 
TB 31 Gerich][kmgerich] for Mozilla.org.
30233b 32
T 33
7fe381 34 INSTALLATION
T 35 ------------
de9f79 36 For detailed instructions on how to install Roundcube webmail on your server,
f11541 37 please refer to the INSTALL document in the same directory as this document.
T 38
5c84da 39 If you're updating an older version of Roundcube please follow the steps
T 40 described in the UPGRADING file.
41
f11541 42
217b80 43 LICENSE
TB 44 -------
7fe381 45 This program is free software: you can redistribute it and/or modify
217b80 46 it under the terms of the GNU General Public License (**with exceptions
TB 47 for skins & plugins**) as published by the Free Software Foundation,
7fe381 48 either version 3 of the License, or (at your option) any later version.
de9f79 49
7fe381 50 This program is distributed in the hope that it will be useful,
T 51 but WITHOUT ANY WARRANTY; without even the implied warranty of
52 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
53 GNU General Public License for more details.
54
55 You should have received a copy of the GNU General Public License
217b80 56 along with this program. If not, see [www.gnu.org/licenses/][gpl].
7fe381 57
T 58 This file forms part of the Roundcube Webmail Software for which the
59 following exception is added: Plugins and Skins which merely make
60 function calls to the Roundcube Webmail Software, and for that purpose
61 include it by reference shall not be considered modifications of
62 the software.
63
64 If you wish to use this file in another project or create a modified
65 version that will not be part of the Roundcube Webmail Software, you
66 may remove the exception above and use this source code under the
67 original version of the license.
68
217b80 69 For more details about licensing and the exceptions for skins and plugins
TB 70 see [roundcube.net/license][license]
f11541 71
T 72
7fe381 73 CONTRIBUTION
T 74 ------------
233622 75 Want to help make Roundcube the best webmail solution ever?
T 76 Roundcube is open source software. Our developers and contributors all
48f5e6 77 are volunteers and we're always looking for new additions and resources.
217b80 78 For more information visit [roundcube.net/contribute][contrib]
30233b 79
T 80
7fe381 81 CONTACT
T 82 -------
977a29 83 For any bug reports or feature requests please refer to the tracking system
217b80 84 at [trac.roundcube.net][tracreport] or subscribe to our mailing list.
TB 85 See [roundcube.net/support][support] for details.
30233b 86
977a29 87 You're always welcome to send a message to the project admin:
217b80 88 hello(at)roundcube(dot)net
TB 89
90
91 [pear]:         http://pear.php.net
92 [iloha]:        http://sourceforge.net/projects/ilohamail/
93 [tinymce]:      http://www.tinymce.com/
94 [googiespell]:  http://orangoo.com/labs/GoogieSpell/
95 [washtml]:      http://www.ubixis.com/washtml/
96 [kmgerich]:     http://kmgerich.com/
97 [gpl]:          http://www.gnu.org/licenses/
98 [license]:      http://roundcube.net/license
99 [contrib]:      http://roundcube.net/contribute
100 [support]:      http://roundcube.net/support
101 [tracreport]:   http://trac.roundcube.net/wiki/Howto_ReportIssues