README

   1 Embrace
   2 =======
   3
   4 About
   5 -----
   6
   7 Embrace is a mail-checker which is based on the Enlightenment Foundation
   8 Libraries.
   9 It monitors your IMAP mailboxes and shows those with new mails in them.
  10
  11
  12 Dependencies
  13 ------------
  14
  15 Embrace depends on ruby-evas and ruby-ecore.
  16
  17
  18 Installation
  19 ------------
  20
  21 Run "rake install" to install Embrace.
  22 The environment variables PREFIX and DESTDIR are honored.
  23
  24
  25 Configuration
  26 -------------
  27
  28 To use Embrace, you will have to create a config file  first, which
  29 tells Embrace what mailboxes you want to have monitored etc.
  30
  31 For an example, please see config.sample.yaml, which can be found
  32 in the Embrace data directory.
  33
  34 Adjust the settings as necessary and install it to
  35 ~/.e/apps/embrace/config.yaml
  36
  37
  38 Usage
  39 -----
  40
  41 The only argument that Embrace optionally takes is the height of the
  42 window in pixels.
  43
  44 So to make it use a window that is 1024 pixels high, you'd run
  45
  46   $ embrace 1024