Updated packaging for new 0.0.2 release.

[qwerkisync] / qtc_packaging / debian_fremantle / README

diff --git a/qtc_packaging/debian_fremantle/README b/qtc_packaging/debian_fremantle/README
index 824cf65..5f4223a 100644 (file)
--- a/qtc_packaging/debian_fremantle/README
+++ b/qtc_packaging/debian_fremantle/README
@@ -1,5 +1,5 @@
 The Debian Package qwerkisync
-----------------------------
+-----------------------------
 
 This package will import and export your communications data to and from files.
 
@@ -10,13 +10,15 @@ It will create backups of your communications database files each time it is
 used. These are located in the usual backups folder should you ever need to
 recover them manually. It will cycle these backups, keeping at most the last 3.
 
-Currently, it supports SMS message import/export to/from VMG files. I plan to
-add call logs, MMS, and chat log support. I also plan to add support for mutiple
-formats for each of these in time (i.e. Android-compatible formats). It also
-currently preserves SMS-transported data such as clender events and
-configuration data. these will show in the rtcom-messaging-ui as contact cards
-as that's the only attachment it expect SMSes to have. They have ot be stored
-however to ensure the export is the same as the import.
+Currently, it supports SMS message import/export to/from VMG files as well as
+voice call logs in a CSV representation of the tables in the Symbian event log
+database as described at teh end of this file. I plan to add MMS, and chat log
+support. I also plan to add support for mutiple formats for each of these in
+time (i.e. Android-compatible formats). It also currently preserves
+SMS-transported data such as clender events and configuration data. these will
+show in the rtcom-messaging-ui as contact cards as that's the only attachment it
+expect SMSes to have. They have ot be stored however to ensure the export is the
+same as the import.
 
 The backends it currently supports are Maemo5's rtcom-eventlogger for all event
 types other than MMS and it will (hopefully!) shortly support Fmms on Maemo5 for
@@ -30,4 +32,24 @@ program.
 component so that's another closed-source package to tick off the freedom list,
 obviously adding support for the new events I'll be adding.
 
- -- Jamie Thompson <maemo@jamie-thompson.co.uk>  Fri, 05 Aug 2011 11:32:52 +0100
+Symbian Event Log Format
+------------------------
+
+A Symbian event log is a bianry database in their own special format. AFAIK, no
+easy open code exists to work with these as the libraries are part of the
+Symbian SDK. Using a tool known as "DBShell" obtained from:
+http://sites.google.com/site/garawaa/
+...you can load these files and export the data within as a CSV. The tool is
+very buggy though.
+
+You will want to export the "event" table to a CSV file (can have any filename).
+In order for Qwerkisync to process the file it must contain the following
+required headers:
+"EType", "ETime", "Remote", "Direction", "Status", "Duration", "Number", "Data"
+
+You will also need to export the "string" table as "string.csv" in the same
+folder as the events CSV.
+
+An export of your current data should give you a good example to work from.
+
+ -- Jamie Thompson <maemo@jamie-thompson.co.uk>  Thu, 13 Oct 2011 02:00:00 +0100