| | |
| 1 | Installing |
| 2 | ------------ |
| 3 | |
| 4 | The typical |
| 5 | |
| 6 | # make |
| 7 | % make install |
| 8 | |
| 9 | should work. The `make` step is needed to compile the |
| 10 | translations. |
| 11 | |
| 12 | Options that modify `make install` behaviour |
| 13 | |
| 14 | LIBDIR |
| 15 | The lib directory to be appended to PREFIX. Default: /lib |
| 16 | PREFIX |
| 17 | The installation prefix. Default: /usr/local |
| 18 | |
| 19 | |
| 20 | Configuring |
| 21 | ----------- |
| 22 | |
| 23 | You need to copy the gmail-sentinel.conf.sample file to your $HOME dir |
| 24 | and rename it .gmail-sentinel.conf |
| 25 | |
| 26 | The sample configuration file is well comment. An exception is the |
| 27 | 'path' option inside the "media" section. This path should point to |
| 28 | the directory were the media files (images) are stored. The default |
| 29 | value should be correct for any installation using the default LIBDIR |
| 30 | and PREFIX values. If you modify the prefix value I'm sure you have |
| 31 | enough knowledge to modify this path to the correct value. |
| toggle raw diff |
--- a/INSTALL
+++ b/INSTALL
@@ -0,0 +1,31 @@
+Installing
+------------
+
+The typical
+
+# make
+% make install
+
+should work. The `make` step is needed to compile the
+translations.
+
+Options that modify `make install` behaviour
+
+ LIBDIR
+ The lib directory to be appended to PREFIX. Default: /lib
+ PREFIX
+ The installation prefix. Default: /usr/local
+
+
+Configuring
+-----------
+
+You need to copy the gmail-sentinel.conf.sample file to your $HOME dir
+and rename it .gmail-sentinel.conf
+
+The sample configuration file is well comment. An exception is the
+'path' option inside the "media" section. This path should point to
+the directory were the media files (images) are stored. The default
+value should be correct for any installation using the default LIBDIR
+and PREFIX values. If you modify the prefix value I'm sure you have
+enough knowledge to modify this path to the correct value. |
| | |
| 2 | 2 | GoogleMail Sentinel README |
| 3 | 3 | ============================ |
| 4 | 4 | |
| 5 | | |
| 6 | | |
| 7 | 5 | About |
| 8 | 6 | ===== |
| 9 | 7 | |
| … | … | |
| 12 | 12 | Features |
| 13 | 13 | ======== |
| 14 | 14 | |
| 15 | | Written using python, gtk+ and libnotify |
| 15 | * Written in python |
| 16 | * Uses gtk+ (status icon) |
| 17 | * Uses libnotify (notifications) |
| 18 | * Multilingual (using gettext) |
| 19 | * Smaller memory footprint (than gmail-notify) |
| 20 | |
| 21 | Limitations |
| 22 | =========== |
| 23 | |
| 24 | 1. It hasn't been tested on Mac or Windows |
| 25 | 2. It doesn't have a configuration GUI (this is done by design) |
| 26 | 3. Pop up notifications don't have a link to open your browser to read your message |
| 16 | 27 | |
| 17 | 28 | Requirements |
| 18 | 29 | ============ |
| … | … | |
| 34 | 34 | libnotify (tested with 0.4.4) |
| 35 | 35 | pynotify (version 0.1.1 - tested with 0.1.1) |
| 36 | 36 | |
| 37 | Current Status |
| 38 | ============== |
| 39 | |
| 40 | Gmail-sentinel is under development, is not intended for general usage |
| 41 | yet. |
| 42 | |
| 43 | History |
| 44 | ======= |
| 45 | |
| 46 | It started as a personal itch. There are many other similar apps, but |
| 47 | I didn't like any of those. http://gmail-notify.sourceforge.net/ was |
| 48 | the closest to good I could find but it has some drawbacks. |
| 49 | |
| 50 | * It didn't work on x86_64 (amd64) by default. |
| 51 | * It uses a binary object that creates the status icon (and because |
| 52 | it was compiled under x86 it didn't worked on amd64) |
| 53 | * Notifications didn't use libnotify (more on this latter) |
| 54 | * Translations were made using xml |
| 55 | |
| 56 | My main goal was, beside learning, to create an app that: |
| 57 | |
| 58 | * Uses gtk.StatusIcon? for the icon in the task bar |
| 59 | * Uses libnotify to display the notifications |
| 60 | * Use gettext for translations |
| 61 | * Reduce the code size (and hopefully the memory footprint) |
| 62 | |
| 63 | |
| 64 | gmail-sentinel is what I came up with. It does everything that I want |
| 65 | (even uses less memory than gmail-notify). gmail-sentinel is |
| 66 | originally a fork of gmail-notify but at this time there isn't much |
| 67 | code left of gmail-notify. |
| 68 | |
| 69 | Disclaimer |
| 70 | ========== |
| 71 | |
| 72 | GoogleMail?, Gmail and Google are trademarks of Google, Inc. This is |
| 73 | project has no relationship with Google, Inc beside using it's code |
| 74 | hosting service. |
| toggle raw diff |
--- a/README
+++ b/README
@@ -2,8 +2,6 @@
GoogleMail Sentinel README
============================
-
-
About
=====
@@ -14,7 +12,18 @@ new mail in your GoogleMail (Gmail) account.
Features
========
-Written using python, gtk+ and libnotify
+* Written in python
+* Uses gtk+ (status icon)
+* Uses libnotify (notifications)
+* Multilingual (using gettext)
+* Smaller memory footprint (than gmail-notify)
+
+Limitations
+===========
+
+ 1. It hasn't been tested on Mac or Windows
+ 2. It doesn't have a configuration GUI (this is done by design)
+ 3. Pop up notifications don't have a link to open your browser to read your message
Requirements
============
@@ -25,3 +34,41 @@ Gtk+ (version 2.10 or higher - tested with 2.12.5)
libnotify (tested with 0.4.4)
pynotify (version 0.1.1 - tested with 0.1.1)
+Current Status
+==============
+
+Gmail-sentinel is under development, is not intended for general usage
+yet.
+
+History
+=======
+
+It started as a personal itch. There are many other similar apps, but
+I didn't like any of those. http://gmail-notify.sourceforge.net/ was
+the closest to good I could find but it has some drawbacks.
+
+ * It didn't work on x86_64 (amd64) by default.
+ * It uses a binary object that creates the status icon (and because
+ it was compiled under x86 it didn't worked on amd64)
+ * Notifications didn't use libnotify (more on this latter)
+ * Translations were made using xml
+
+My main goal was, beside learning, to create an app that:
+
+ * Uses gtk.StatusIcon? for the icon in the task bar
+ * Uses libnotify to display the notifications
+ * Use gettext for translations
+ * Reduce the code size (and hopefully the memory footprint)
+
+
+gmail-sentinel is what I came up with. It does everything that I want
+(even uses less memory than gmail-notify). gmail-sentinel is
+originally a fork of gmail-notify but at this time there isn't much
+code left of gmail-notify.
+
+Disclaimer
+==========
+
+GoogleMail?, Gmail and Google are trademarks of Google, Inc. This is
+project has no relationship with Google, Inc beside using it's code
+hosting service. |
