Changeset 1864 in subversion


Ignore:
Timestamp:
Sep 20, 2008 10:22:40 AM (5 years ago)
Author:
thomasb
Message:

Remove code documentation from README

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/roundcubemail/README

    r1543 r1864  
    1515RoundCube Webmail is a browser-based multilingual IMAP client with an 
    1616application-like user interface. It provides full functionality you expect 
    17 from an e-mail client, including MIME support, address book, folder manipulation, 
     17from an e-mail client, including MIME support, address book, folder management, 
    1818message searching and spell checking. RoundCube Webmail is written in PHP and 
    19 requires the MySQL, PostgreSQL or SQLite database. The user interface is fully skinnable 
    20 using XHTML and CSS 2. 
     19requires the MySQL, PostgreSQL or SQLite database. The user interface is fully 
     20skinnable using XHTML and CSS 2. 
    2121 
    2222This project is meant to be a modern webmail solution which is easy to 
     
    3636 
    3737 
    38 Licensing:  
     38Licensing: 
    3939---------- 
    4040This product is distributed under the GPL. Please read through the file 
     
    4242 
    4343 
    44 How it works: 
     44Contribution: 
    4545------------- 
    46 The main authority for the RoundCube access is the IMAP server. If 
    47 'auto_create_user' is set to TRUE in config/main.inc.php a new record in the 
    48 user table will be created once the IMAP login succeeded. This user record does 
    49 not store a password, it's just used to assign identities, contacts and cache 
    50 records. If you have 'auto_create_user' set to FALSE only IMAP logins which 
    51 already have a corresponding entry in the user's table (username and hostname) 
    52 will be allowed. 
    53  
    54  
    55 Code Layout: 
    56 ------------ 
    57 Basic sequence (index.php): 
    58   - index.php -> rcmail_load_gui -> new rcmail_template -> rcmail_template::send 
    59   - authentication details in this sequence 
    60  
    61 Tasks 
    62   - index.php limits tasks to set list 
    63   - can see task in roundcube link when you mouse over it 
    64   - task templates stored in skins/default/templates 
    65   - templates "roundcube:" tokens that get replaced in rcmail_template class 
    66  
    67 program/include/rcube_shared.inc 
    68   - defines rcube_html_page, class that lays out a roundcube web page 
    69   - defines form control classes 
    70   - provides common functions 
     46Want to help make RoundCube the best webmail solution ever? 
     47RoundCube is open source software. Our developers and contributors all 
     48are volunteers and we're always looking for new additions and resources. 
     49For more information visit http://roundcube.net/contribute 
    7150 
    7251 
Note: See TracChangeset for help on using the changeset viewer.