A first, short, incomplete ReadMe has been added
[licom.git] / ReadMe
1  Lightweight Contact Manager - LiCoM
2 -===================================-
3
4 LiCoM is a contact manager I started writing because my family, my friends and
5 myself were not very comfortable with the many existing address book scripts.
6 The demands were:
7 - High compatibility with existing e-mail readers
8 - Read and write operations
9 - Export to vCards
10 - Print lists of groups and/or all contacts
11 - Multi-user capable
12
13 These requirements are tried to be met with the following approach:
14 - Data is kept in an LDAP database (the overall layout is shown in "The big
15   picture")
16 - The LDAP-server is accessed through perl modules which prodide a high-level
17   interface to the database.
18 - On top of these modules a CGI-script has been written.
19
20
21
22 The big picture
23 ---------------
24
25 [dc=org]
26  |
27  `->[dc=verplant]
28      |
29      `->[ou=addresses]
30          |
31          +->[cn=Forster Florian]
32          |   |
33          |   +->[cn=Test Person]
34          |   +->[cn=Someone Else]
35          |   :  ...
36          |   `->[cn=Last Person]
37          |
38          +->[cn=Another User]
39          |   |
40          |   +->[cn=Still More Entries]
41          :   :
42