From f39201903c8318148249ae4fe62547a93a622799 Mon Sep 17 00:00:00 2001 From: Tilman Sauerbeck Date: Mon, 27 Aug 2007 20:37:09 +0200 Subject: [PATCH] Added README. --- README | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..a4b877e --- /dev/null +++ b/README @@ -0,0 +1,46 @@ +Embrace +======= + +About +----- + +Embrace is a mail-checker which is based on the Enlightenment Foundation +Libraries. +It monitors your IMAP mailboxes and shows those with new mails in them. + + +Dependencies +------------ + +Embrace depends on ruby-evas and ruby-ecore. + + +Installation +------------ + +Run "rake install" to install Embrace. +The environment variables PREFIX and DESTDIR are honored. + + +Configuration +------------- + +To use Embrace, you will have to create a config file first, which +tells Embrace what mailboxes you want to have monitored etc. + +For an example, please see config.sample.yaml, which can be found +in the Embrace data directory. + +Adjust the settings as necessary and install it to +~/.e/apps/embrace/config.yaml + + +Usage +----- + +The only argument that Embrace optionally takes is the height of the +window in pixels. + +So to make it use a window that is 1024 pixels high, you'd run + + $ embrace 1024 -- 2.30.2