Split things so that there can be a standalone zavai-calendar application
[gregoa/zavai.git] / README
diff --git a/README b/README
index 737a73b5b33519640debd02a1938f9b8d9032c05..d1889b9d413e16d4ac34b8c79a3dca6c812ea532 100644 (file)
--- a/README
+++ b/README
@@ -11,9 +11,14 @@ Getting it to work:
 
  * Install dependencies
 
-   apt-get install valac libglib2.0-dev libdbus-glib-1-dev libgee-dev libgtk2.0-dev libwnck-dev
+   # Build time
+   apt-get install valac libglib2.0-dev libdbus-glib-1-dev libgee-dev libgtk2.0-dev libwnck-dev libdevkit-power-gobject-dev
 
-   Optional: apt-get install polygen polygen-data
+   # Runtime
+   apt-get install devicekit-power
+
+   # Optional runtime
+   apt-get install polygen polygen-data
 
  * Compile
 
@@ -36,6 +41,11 @@ Getting it to work:
    cp /usr/share/applications/FBReader.desktop ~/.zavai
    cp conf/satmon.desktop ~/.zavai
 
+ * Copy accessory scripts in ~/.zavai
+
+   cp hooks/display ~/.zavai
+   cp hooks/keyboard ~/.zavai
+
  * Update the information about the polygen grammars installed in the system
    (optional) 
 
@@ -97,12 +107,17 @@ Features / guide
  * Alarms
 
  It is possible to set an alarm, which will be shown in the alarm window. When
- the alarm expires, the phone wakes up if it is suspended, and zavai does
- nothing but print an error message on standard error.
+ the alarm expires, the phone wakes up if it is suspended, and zavai vibrates
+ for 5 seconds.
+
+ It is planned to use the AUX button to acknowledge the alarm and stop the
+ vibration; when this will happen, vibration can go on for more than 5 seconds.
  
- When there will be a documented API to turn OFF the vibrator, I'll implement
- vibration on alarm.  When I'll implement some audio playing infrastructure,
- I'll implement playing an audio file as well.
+ When I'll implement some audio playing infrastructure, I'll implement playing
+ an audio file as well.
+
+ Also missing are a popup that tells that an alarm is ringing, and a notifier
+ for unacknowledged popups.
 
  Patches welcome.
 
@@ -137,11 +152,22 @@ TODO list / wish list
  http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/index.html;hb=HEAD
 
  * Features to add:
+ - zavai-calendar to use as a calendar popup for lxde
+ - zavai calendar: show month notes
+ - zavai calendar: show global notes
+ - contacts: show as a fancy focus+context list (see prefuse)
+ - GSM power and network
+    - link to open SHR-dialer
+ - icon to show if there are new messages
+    - link to open SHR-messages
  - switch backlight keep mode when on power/recharging
     - the button changes the default for the current power mode
  - alarm
-    - vibrate at alarm trigger
+    + vibrate at alarm trigger
     - play sound at alarm trigger
+    - acknowledge alarms with AUX button
+       - then, vibrate and play sound for longer
+    - popup that tells that an alarm is ringing
     - leave expired alarm on screen until acknowledged
       (alarm status icon that also brings to alarm menu)
     - remember alarm names (on request, maybe with an add feature) and how
@@ -149,6 +175,7 @@ TODO list / wish list
     - remember unexpired alarms persistently (again, a table in sqlite?) so
       that they can be reinstated if zavai is restarted
     - show active alarms and allow to delete them
+ - unlock screen when receiving phone calls
  - GPX status icon (off, waiting for fix, recording)
  - GPX waypoint using AUX button
  - GPX + Audio track