Mention CVS and git on main documentation "how to" list
[barry/pauldeden.git] / doc / www / index.php
blob8fe0fed46f50f85da7db6f5ac3a5eeca46a4995c
1 <? createHeader("barry - BlackBerry &trade; synchronization for Linux"); ?>
3 <? include ("barry.inc"); ?>
5 <div class="subHeader">Overview</div>
7 <p>Linux users who also use a BlackBerry &trade; now have an option for
8 managing their BlackBerry directly from Linux.</p>
10 <p>Barry is an Open Source application that will allow synchronization,
11 backup, restore and program management for BlackBerry &trade; devices.
12 Barry is primarily developed on Linux, but is intended as a cross platform
13 library and application set, targetting Linux, BSD, 32/64bit, and big/little
14 endian systems.
15 </p>
17 <p>Barry is currently in early development, but is reaching stages of
18 usefulness. For example, it is possible to:
20 <ul>
21 <li> retrieve Address Book, Email, Calendar, Service Book, Memos,
22 Tasks, PIN Messages, Saved Email, and Folders </li>
23 <li> export Address Book contacts in text or LDAP LDIF format </li>
24 <li> make full data backups and restores of your device using
25 a GUI</li>
26 <li> synchronize contacts and calendar items using the
27 <a href="http://www.opensync.org/">OpenSync</a>
28 framework (experimental) </li>
29 <li> use the Blackberry as a modem (experimental) </li>
30 </ul>
31 </p>
33 <div class="subHeader">Status</div>
35 <p>
36 <ul>
37 <li>Latest release: <b>0.13</b></li>
38 <li>Download source and binary packages from
39 <a href="http://sourceforge.net/project/showfiles.php?group_id=153722">Sourceforge</a></li>
40 <li>General <a href="http://sourceforge.net/projects/barry/">Sourceforge project page</a></li>
41 </ul>
42 </p>
44 <div class="subHeader">Getting Started</div>
46 <p>How do I...
47 <ul>
48 <li><? createLink("install", "Install Barry from binary packages"); ?></li>
49 <li><? createLink("cvs", "Install Barry from CVS or git"); ?></li>
50 <li><? createLink("backups", "Make backups of my Blackberry data"); ?></li>
51 <li><? createLink("sync", "Sync my Blackberry with Evolution"); ?></li>
52 <li><? createLink("modem", "Use my Blackberry as a modem to surf the net"); ?></li>
53 <li><? createLink("troubleshooting", "Find troubleshooting help"); ?></li>
54 <li><? createLink("bugs", "Report a bug"); ?></li>
55 <li><? createLink("patches", "Submit a patch"); ?></li>
56 <li><? createLink("contact", "Contact the developers"); ?></li>
57 </ul>
58 </p>
60 <p>Some helpful lists:
61 <ul>
62 <li><? createLink("requirements", "System requirements"); ?></li>
63 <li><? createLink("dependencies", "Software dependencies"); ?></li>
64 </ul>
65 </p>
68 <div class="subHeader">How to Help</div>
70 <p>If you are a C++ programmer, grab the source from
71 <? createLink("cvs", "CVS"); ?> and take a look at the TODO file.
72 Post a message to the
73 <a href="http://sourceforge.net/mail/?group_id=153722">mailing list</a>
74 when you start working on any of the listed features, so you can connect
75 with other developers, and avoid duplicating effort.</p>
77 <p>If you are a Python programmer, contact the mailing list, since we
78 would like to create and test a Python interface to the Barry library.</p>
80 <p>If you are not a programmer, but have a Blackberry, we can always use
81 help in testing. Install Barry on your system, and
82 <? createLink("bugs", "report any bugs"); ?> you find.</p>
84 <p>If you prefer writing documentation, grab the source from
85 <? createLink("cvs", "CVS"); ?> and look under the doc/www directory.
86 Documentation is currently in html form, as well as doxygen-generated
87 API documentation found in the comments of the source code itself.
88 Patches updating either set of documentation are welcome.</p>
90 <p>There are dozens of databases that need to be documented and supported
91 in the library. If you have a BlackBerry &trade; device and are interested
92 in helping decipher data, we have a
93 <? createLink("hacking", "Barry hacking document"); ?> that will help you.
94 </p>
96 <div class="subHeader">Design</div>
98 <p>If you are interested in helping out or just interested in how it works,
99 check out our <? createLink("design", "design notes"); ?>.
101 <div class="subHeader">Roadmap</div>
103 <p>We have put together a document that describes where we are and where we
104 want to take Barry. Check out our <? createLink("roadmap", "roadmap"); ?>
105 to see what's happening.</p>