]> git.notmuchmail.org Git - sup/commitdiff
doc tweaks for 0.1 release
authorwmorgan <wmorgan@5c8cc53c-5e98-4d25-b20a-d8db53a31250>
Tue, 17 Jul 2007 21:41:33 +0000 (21:41 +0000)
committerwmorgan <wmorgan@5c8cc53c-5e98-4d25-b20a-d8db53a31250>
Tue, 17 Jul 2007 21:41:33 +0000 (21:41 +0000)
git-svn-id: svn://rubyforge.org/var/svn/sup/trunk@502 5c8cc53c-5e98-4d25-b20a-d8db53a31250

History.txt
Manifest.txt
README.txt
doc/FAQ.txt
doc/Philosophy.txt
www/index.html

index 55673ced281bd1aa5065d60759fa75dc52456d2c..d9daf70ec570bf485f18d4895f53ee14c99e1729 100644 (file)
@@ -1,3 +1,14 @@
+== 0.1 / 2007-07-17
+* MIME attachment creation.
+* i18n support: character set conversion and rfc2047 header decoding.
+* Better MIME handling.
+* Multiple account support.
+* Locking and concurrent Sup process detection and killation.
+* Thread autoloading when you scroll down.
+* Batch deletion of messages marked deleted or spam from message
+  sources via sup-sync-back tool (mbox only).
+* Millions of bugfixes.
+
 == 0.0.8 / 2007-04-01
 
 * Maildir support!
index fdaebdee058b2dd432160e501b8ac4acdd88dba3..c499da0197a3da5f4c6adca7487df02d34ebc5c9 100644 (file)
@@ -38,6 +38,7 @@ lib/sup/modes/completion-mode.rb
 lib/sup/modes/compose-mode.rb
 lib/sup/modes/contact-list-mode.rb
 lib/sup/modes/edit-message-mode.rb
+lib/sup/modes/file-browser-mode.rb
 lib/sup/modes/forward-mode.rb
 lib/sup/modes/help-mode.rb
 lib/sup/modes/inbox-mode.rb
@@ -54,7 +55,6 @@ lib/sup/modes/search-results-mode.rb
 lib/sup/modes/text-mode.rb
 lib/sup/modes/thread-index-mode.rb
 lib/sup/modes/thread-view-mode.rb
-lib/sup/modes/file-browser-mode.rb
 lib/sup/person.rb
 lib/sup/poll.rb
 lib/sup/rfc2047.rb
index e37a7283e88984da54d794e87444254bf6821ad5..1b2b516380c22857baf8287c3770bac5df9e34b5 100644 (file)
@@ -4,9 +4,10 @@ sup
 
 == DESCRIPTION:
 
-Sup is a console-based email client that combines the best
-features of GMail, mutt, and emacs. Sup matches the power of GMail
-with the speed and simplicity of a console interface.
+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.
@@ -84,24 +85,15 @@ Current limitations which will be fixed:
 
 == SYNOPSYS:
 
-  1. sup-import <source>+
-  2. sup
-  3. edit ~/.sup/config.yaml for the (very few) settings sup has
-
-  Where <source> is a filename (for mbox files), an imap or imaps URI,
-  or a mbox+ssh URI (for remote mbox files). You will be prompted for
-  a username and password if required.
-
-  sup-import has several options which control whether you want
-  messages from particular mailboxes not to be added to the inbox, or
-  not to be marked as new, so run it with -h for help.
+  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-import --rebuild.
+  sup-sync --changed.
 
 == REQUIREMENTS:
 
@@ -109,8 +101,10 @@ Current limitations which will be fixed:
 * ncurses
 * rmail
 * highline
-* trollop
 * net-ssh
+* trollop >= 1.7
+* lockfile
+* mime-types
 
 == INSTALL:
 
index 1c5c5cc49afef3df8bd22ff018c30d85c4545a3b..f2cc7cfb34b1cc6a6c5c90eda295edf8252e029b 100644 (file)
@@ -3,10 +3,9 @@ Sup FAQ
 
 Q: What is Sup?
 A: 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 subscribed to high-volume mailing lists and never deletes any
-   email, Sup is for you.
+   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.
 
 Q: What does Sup stand for?
 A: "What's up?"
index 18479fbab97628014f30893fbd9bede4313e2f5a..bdbe28f4198617c22809a522ff84fa270afc59b6 100644 (file)
@@ -1,41 +1,41 @@
 Should an email client have a philosophy? For many people, email is
-one of our primary means of communication. Something so important
-ought to warrant a little thought.
+one of our primary means of communication, and email archives are an
+integral part of our long-term memory. Something so important ought to
+warrant a little thought.
 
 Here's Sup's philosophy.
 
 Using "traditional" email clients today is increasingly problematic.
 Anyone who's on a high-traffic mailing list knows this. My ruby-talk
 folder is 430 megs and Mutt sits there for 60 seconds while it opens
-it. Keeping up with the all the new traffic is painful, even with
+it. Keeping up with the all the new traffic is impossible, even with
 Mutt's excellent threading features, simply because there's so much of
 it. A single thread can span several pages in the folder index view
-alone! And Mutt is probably the fastest email client out there, and
-certainly most featureful and in terms of threading and mailing list
-support. God help me if I try and throw Thunderbird at that.
+alone! And Mutt is probably the fastest, most mailing-list aware email
+client out there. God help me if I try and use Thunderbird.
 
-The principle problem with traditional clients is that they deal with
+The problem with traditional clients like Mutt is that they deal with
 individual pieces of email. This places a high mental cost on the user
 for each incoming email, by forcing them to ask: Should I keep this
-email, or delete it? If I keep it, where should I file it? For
-example, I've spent the last 10 years of my life laboriously
-hand-filing every email message I received and feeling a mild sense of
-panic every time an email was both "from Mom" and "about school". The
-massive amounts of email that many people receive, and the cheap cost
-of storage, have made these questions both more costly and less useful
-to answer.
+email, or delete it? If I keep it, where should I file it? I've spent
+the last 10 years of my life laboriously hand-filing every email
+message I received and feeling a mild sense of panic every time an
+email was both "from Mom" and "about school". The massive amounts of
+email that many people receive, and the cheap cost of storage, have
+made these questions both more costly and less useful to answer.
 
-I think Gmail has taken the right approach. As a long-time Mutt user,
-I was pretty much blown away when I first saw people use Gmail,
-because I saw them treat email differently from how I ever had. I saw
-that making certain operations quantitatively easier (namely, search)
-resulted in a qualitative difference in usage. You didn't have to
-worry about filing things into folders correctly, because you could
-just find things later by searching for them. I also saw how
-thread-centrism was advantageous over message-centrism when message
-volume was high: if nothing else, there's simply less of them.
+Contrast that with using Gmail. As a long-time Mutt user, I was blown
+away when I first saw someone use Gmail. They treated their email
+differently from how I ever had. They never filed email and they never
+deleted it. They relied on an immediate, global, full-text search, and
+thread-level tagging, to do everything I'd ever done with Mutt, but
+with a trivial cost to the user at message receipt time.
 
-Much of the inspiration for Sup was based on Gmail. I think it's to
+From Gmail I learned that making certain operations quantitatively
+easier (namely, search) resulted in a qualitative improvement in
+usage. I also learned how thread-centrism was advantageous over
+message-centrism when message volume was high: most of the time, a
+message and its context deserve the same treatment. I think it's to
 the Gmail designers' credit that they started with a somewhat ad-hoc
 idea (hey, we're really good at search engines, so maybe we can build
 an email client on top of one) and managed to build something that was
@@ -43,15 +43,16 @@ actually better than everything else out there. At least, that's how I
 imagine in happened. Maybe they knew what they were doing from the
 start.
 
-But ultimately, Gmail wasn't right for me (fuck top posting and HTML
-mail), which is why the idea for Sup was born.
+Unfortunately, there's a lot to Gmail I can't tolerate (top posting,
+HTML mail, one-level threads, and ads come to mind, never mind the
+fact that it's not FOSS). Thus Sup was born.
 
 Sup is based on the following principles, which I stole directly from
 Gmail:
 
 - An immediately accessible and fast search capability over the entire
-  email archive eliminates most of the need for folders, and
-  eliminates the necessity of having to ever delete email.
+  email archive eliminates most of the need for folders, and most of
+  the necessity of deleting email.
 
 - Labels eliminate what little need for folders search doesn't cover.
 
@@ -65,4 +66,4 @@ do with the fantastic productivity of a console- and keyboard-based
 application, the usefulness of multiple buffers, the necessity of
 handling multiple email accounts, etc. But those are just details!
 
-Let me know what you think.
+Try it and let me know what you think.
index 91daa73cf71af35969f8d89b1b917901bb658017..d6917633b38660061ef896d12023b129e365dfc9 100644 (file)
                <h1>Sup</h1>
 
                <p>
-               Sup is a console-based email client that combines the best features
-               of Gmail, mutt, and emacs. Sup matches the power of Gmail with the
-               speed and simplicity of a console interface.
+   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.
                </p>
 
                <p>
                <h2>Status</h2>
 
                <p>
-               The current version of Sup is 0.0.8, released 2007-04-01. This is a
-               beta release. It is unix-centric and has no i18n support. It supports
-               mbox, mbox over ssh, IMAP, IMAPS, and Maildir. It does not support POP
-               or Gmail. I plan to fix all of these problems.
+               The current version of Sup is 0.1, released 2007-07-17. This is a
+               beta release. It supportsm box, mbox over ssh, IMAP, IMAPS, and Maildir. It does not support POP
+               or Gmail accounts yet.
                </p>
 
                <p>
-               Other than those limitations, it works great! I use it for my everyday
+               There are a few known bugs, but overall it works great! I use it for my everyday
                email, and it makes dealing with 85,000 messages a breeze.
                </p>