sup

commit cb079bc3975810e5ac33565d49b4130a802a6ffe
parent 45aafa624d45b7cae147f21a626945c613851676
Author: Whyme.Lyu <callme5long@gmail.com>
Date:   Sun, 12 May 2013 02:57:20 -0700

Merge pull request #44 from 5long/rework-readme

Cleanup README and stick with markdown
Diffstat:

3 files changed, 77 insertions(+), 139 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,70 @@
+# Sup
+
+A console-based email client with the best features of GMail, mutt and
+Emacs.
+
+## Installation
+
+[See the wiki][Installation]
+
+## Features / Problems
+
+Features:
+
+* GMail-like thread-centered archiving, tagging and muting
+* [Handling mail from multiple mbox and Maildir sources][sources]
+* Blazing fast full-text search with a [rich query language][search]
+* Multiple accounts - pick the right one when sending mail
+* [Ruby-programmable hooks][hooks]
+* Automatically tracking recent contacts
+
+Current limitations which will be fixed:
+
+* [Doesn't run on Ruby 2.0][ruby20]
+
+* Sup doesn't play nicely with other mail clients. Changes in Sup won't be
+  synced back to mail source.
+
+* Unix-centrism in MIME attachment handling and in sendmail invocation.
+
+## Problems
+
+Please report bugs to the [Github issue tracker](https://github.com/sup-heliotrope/sup/issues).
+
+## Links
+
+* [Homepage](http://supmua.org/)
+* [Code repository](https://github.com/sup-heliotrope/sup)
+* [Wiki](https://github.com/sup-heliotrope/sup/wiki)
+* IRC: [#sup @ freenode.net](http://webchat.freenode.net/?channels=#sup)
+* Mailing list: [sup-talk] and [sup-devel]
+
+## License
+
+```
+Copyright (c) 2013       Sup developers.
+Copyright (c) 2006--2009 William Morgan.
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301, USA.
+```
+
+[sources]: https://github.com/sup-heliotrope/sup/wiki/Adding-sources
+[hooks]: https://github.com/sup-heliotrope/sup/wiki/Hooks
+[search]: https://github.com/sup-heliotrope/sup/wiki/Searching-your-mail
+[Installation]: https://github.com/sup-heliotrope/sup/wiki#installation
+[ruby20]: https://github.com/sup-heliotrope/sup/wiki/Development#sup-014
+[sup-talk]: http://rubyforge.org/mailman/listinfo/sup-talk
+[sup-devel]: http://rubyforge.org/mailman/listinfo/sup-devel
diff --git a/README.txt b/README.txt
@@ -1,132 +0,0 @@
-sup
-    originally by William Morgan <wmorgan-sup@masanjin.net>
-    http://supmua.org
-
-== DESCRIPTION:
-
-Sup is a console-based email client for people with a lot of email.
-It supports tagging, very fast full-text search, automatic contact-
-list management, and more. If you're the type of person who treats
-email as an extension of your long-term memory, Sup is for you.
-
-Sup makes it easy to:
-- Handle massive amounts of email.
-
-- Mix email from different sources: mbox files and Maildirs.
-
-- Instantaneously search over your entire email collection. Search over
-  body text, or use a query language to combine search predicates in any
-  way.
-
-- Handle multiple accounts. Replying to email sent to a particular
-  account will use the correct SMTP server, signature, and from address.
-
-- Add custom code to customize Sup to whatever particular and bizarre
-  needs you may have.
-
-- Organize email with user-defined labels, automatically track recent
-  contacts, and much more!
-
-The goal of Sup is to become the email client of choice for nerds
-everywhere.
-
-== FEATURES/PROBLEMS:
-
-Features:
-
-- Scalability to massive amounts of email. Immediate startup and
-  operability, regardless of how much amount of email you have.
-
-- Immediate full-text search of your entire email archive, using the
-  Xapian query language. Search over message bodies, labels, from: and
-  to: fields, or any combination thereof.
-
-- Thread-centrism. Operations are performed at the thread, not the
-  message level. Entire threads are manipulated and viewed (with
-  redundancies removed) at a time.
-
-- Labels instead of folders. Drop that tired old metaphor and you'll see
-  how much easier it is to organize email.
-
-- GMail-style thread management. Archive a thread, and it will disappear
-  from your inbox until someone replies. Kill a thread, and it will
-  never come back to your inbox (but will still show up in searches.)
-  Mark a thread as spam and you'll never again see it unless explicitly
-  searching for spam.
-
-- Console based interface. No mouse clicking required!
-
-- Programmability. It's in Ruby. The code is good. It has an extensive
-  hook system that makes it easy to extend and customize.
-
-- Multiple buffer support. Why be limited to viewing one thing at a
-  time?
-
-- Tons of other little features, like automatic context-sensitive help,
-  multi-message operations, MIME attachment viewing, recent contact list
-  generation, etc.
-
-Current limitations which will be fixed:
-
-- Sup doesn't play nicely with other mail clients. If you alter a mail
-  source (read, move, delete, etc) with another client Sup will punish
-  you with a lengthy reindexing process.
-
-- Unix-centrism in MIME attachment handling and in sendmail invocation.
-
-== SYNOPSYS:
-
-  0. sup-config
-  1. sup
-
-  Note that Sup never changes the contents of any mailboxes; it only
-  indexes in to them. So it shouldn't ever corrupt your mail. The flip
-  side is that if you change a mailbox (e.g. delete messages, or, in the
-  case of mbox files, read an unread message) then Sup will be unable to
-  load messages from that source and will ask you to run sup-sync
-  --changed.
-
-== REQUIREMENTS:
-
- - xapian-full-alaveteli >= 1.2
- - ncursesw-sup >= 1.3.1
- - rmail >= 0.17
- - highline
- - trollop >= 1.12
- - lockfile
- - mime-types
- - gettext
-
-== INSTALL:
-
-* gem install sup
-
-== PROBLEMS:
-
-Report bugs to the github page:
-  https://github.com/sup-heliotrope/sup/issues
-
-Or check the mailing lists:
-  * http://rubyforge.org/mailman/listinfo/sup-talk
-  * http://rubyforge.org/mailman/listinfo/sup-devel
-
-== LICENSE:
-
-Copyright (c) 2013       Sup developers.
-Copyright (c) 2006--2009 William Morgan.
-
-This program is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public License
-as published by the Free Software Foundation; either version 2
-of the License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-02110-1301, USA.
-
diff --git a/sup.gemspec b/sup.gemspec
@@ -6,7 +6,7 @@ require 'sup/version'
 # Files
 SUP_EXECUTABLES = %w(sup sup-add sup-config sup-dump sup-import-dump
   sup-recover-sources sup-sync sup-sync-back sup-tweak-labels)
-SUP_EXTRA_FILES = %w(CONTRIBUTORS README.txt LICENSE History.txt ReleaseNotes)
+SUP_EXTRA_FILES = %w(CONTRIBUTORS README.md LICENSE History.txt ReleaseNotes)
 SUP_FILES =
   SUP_EXTRA_FILES +
   SUP_EXECUTABLES.map { |f| "bin/#{f}" } +
@@ -25,12 +25,12 @@ module Redwood
     s.description = <<-DESC
       Sup is a console-based email client for people with a lot of email.
 
-      - Handling mail from multiple mbox and Maildir sources
-      - GMail-like archiving and tagging
-      - Blazing fast full-text search with a rich query language
-      - Multiple accounts - pick the right one when sending mail
-      - Ruby-programmable hooks
-      - Automatically tracking recent contacts
+      * GMail-like thread-centered archiving, tagging and muting
+      * Handling mail from multiple mbox and Maildir sources
+      * Blazing fast full-text search with a rich query language
+      * Multiple accounts - pick the right one when sending mail
+      * Ruby-programmable hooks
+      * Automatically tracking recent contacts
 DESC
     s.license = 'GPL-2'
     s.files = SUP_FILES