]> code.delx.au - gnu-emacs-elpa/blobdiff - packages/gnorb/README.org
Merge commit '0b9eb2b647a49ffa3dc4e3e61cb8bd94c7fe3634' as 'packages/gnorb'
[gnu-emacs-elpa] / packages / gnorb / README.org
diff --git a/packages/gnorb/README.org b/packages/gnorb/README.org
new file mode 100644 (file)
index 0000000..cbb13af
--- /dev/null
@@ -0,0 +1,31 @@
+* Gnorb
+
+Glue code between the Gnus, Org, and BBDB packages for Emacs.
+
+This package connects Emacs-based email, project management, and
+contact management a little more closely together. The goal is to
+reduce friction when manipulating TODOs, contacts, messages, and
+files.
+
+Probably the most interesting thing Gnorb does is tracking
+correspondences between Gnus email messages and Org headings. Rather
+than "turning your inbox into a TODO list", as some software puts it,
+Gnorb (kind of) does the opposite: turning your TODO headings into
+mini mailboxes.
+
+*Note for previous users*: If you were using Gnorb from Github before
+it shifted to the Elpa repository, the email tracking mechanism has
+changed, please see the manual for details.
+
+** Installation
+
+It's easiest to install Gnorb from Elpa: run `list-packages' and look
+for it there.
+
+Or clone the Git repo at https://github.com/girzel/gnorb, and add the
+top-level directory to your load path.
+
+If you want to use Gnorb for tracking emails with TODOs, you'll need
+to add a nngnorb server to your `gnus-secondary-select-methods'
+variable, then call `gnorb-tracking-initialize' in your init files.
+Again, see the manual for details.