diff --git a/README b/README deleted file mode 100644 index 8d1b69889..000000000 --- a/README +++ /dev/null @@ -1,116 +0,0 @@ - - Wanderlust -- Yet Another Message Interface on Emacsen - by Yuuichi Teranishi - - -Wanderlust is a mail/news management system with IMAP4rev1 support for Emacs. - -Features: - - * Implementation in elisp only. - * Support of IMAP4rev1 [1], NNTP [2], POP(POP3[3]/APOP), MH and Maildir. - * Integrated access to messages based on Folder Specifications like Mew[4]. - * Key bindings and mark processing like Mew. - * Management of threads and unread messages. - * Folder mode to select and edit subscribed folders. - * Message cache, Disconnected Operation. - * MH-like Fcc (Fcc: %Backup is possible). - * Full support of MIME (by SEMI). - * Draft editing of mail and news as a same interface. - * Icon based interface for the list of Folder (XEmacs and Emacs 21). - * Skip fetching of a large message part of MIME(IMAP4). - * Server side searching (IMAP4), internationalized searching is available. - * Virtual folder. - * Compressed folder. - * Automatic expiration of old messages. - * Automatic refiling. - * Draft templates. - -System Requirements: - -See INSTALL. - -Install: - -See INSTALL to install. - -Web Page: - -Wanderlust Official web page is available at: - -http://www.gohome.org/wl/. - -You can get latest Wanderlust version from there. - -Mailing List: - -Via the Wanderlust ML, we discuss about Wanderlust, announce the latest -release. - -Wanderlust Mailing List - -In this list, Japanese is mainly used for discussion. We also have a list -for discussion in English: - -Wanderlust List in English - -(NOTE: messages posted to the latter are also forwarded to the former) - -To subscribe, send mail to wl-ctl@ml.gentei.org (or send mail to -wl-en-ctl@ml.gentei.org for English list), with '# guide' as the message -body. - -CVS: - - Development of Wanderlust uses CVS. So latest developing version is - available at CVS. - -(0) cvs login (first time only) - - % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login - - CVS password: [CR] # NULL string - -(1) checkout - - % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout wanderlust - - To get Wanderlust from stable branch, do following instead of above - - % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout -r wl-2_14 wanderlust - - You can also view CVS repository via - - http://cvs.m17n.org/viewcvs/root/wanderlust/ - - If you want to receive CVS commit log via e-mail, follow instructions in - - http://cvs.m17n.org/ - -Development: - - If you would like to join CVS based development, please send mail to - - cvs@cvs.m17n.org - - with your account name and your public key for ssh. cvsroot is - :ext:cvs@cvs.m17n.org:/cvs/root. - - We hope you will join the open development. - -References: - -[1] M. Crispin, "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1", RFC 2060, - 1996. -[2] B. Kantor and P. Lapsley, "Network News Transfer Protocol: A - Proposed Standard for the Stream-Based Transmission of News", RFC - 977, 1986. -[3] J. Myers, M. Rose, "Post Office Protocol - Version 3", RFC 1929, 1996. -[4] "Mew -- Messaging in the Emacs World", - (Copyright (C) 1994, 1995, 1996, 1997, 1998 Mew developing team.) - Available from http://www.mew.org/. -[5] "tm -- MIME package for GNU Emacs", - (Copyright (C) 1994, 1995, 1996 MORIOKA Tomohiko) - Latest tm package is available from - ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ - diff --git a/README.md b/README.md new file mode 100644 index 000000000..9e4d4cf3c --- /dev/null +++ b/README.md @@ -0,0 +1,107 @@ +Wanderlust - Yet Another Message Interface on Emacsen +===================================================== + +Wanderlust is a mail/news management system with [IMAP4rev1][1] support for +[Emacs][2]. It was originally developed by [Yuuichi Teranishi][3]. + +For documentation, see also: [Wanderlust on EmacsWiki][4] + + +Features +======== + + * Implementation in elisp only. + + * Support of [IMAP4rev1][5], [NNTP][6], POP([POP3][7]/APOP), MH and Maildir. + + * Integrated access to messages based on Folder Specifications like [Mew][8]. + + * Key bindings and mark processing like Mew. + + * Management of threads and unread messages. + + * Folder mode to select and edit subscribed folders. + + * Message cache, Disconnected Operation. + + * MH-like Fcc (Fcc: %Backup is possible). + + * Full support of MIME (by SEMI). + + * Draft editing of mail and news as a same interface. + + * Icon based interface for the list of Folder (XEmacs and Emacs 21). + + * Skip fetching of a large message part of MIME(IMAP4). + + * Server side searching (IMAP4), internationalized searching is available. + + * Virtual folder. + + * Compressed folder. + + * Automatic expiration of old messages. + + * Automatic refiling. + + * Draft templates. + + +Installation +============ + +See: [INSTALL](INSTALL) + + +Mailing List +============ + +You can get information and help via the mailing list at: + + * English: [wl-en@ml.gentei.org][9] ([archives][10]) + + * Japanese: [wl@ml.gentei.org][11] ([archives][12]) + +Emails to the English list are forwarded to the Japanese list. + +To subscribe, send an email to [wl-ctl@ml.gentei.org][13] (Japanese) or +[wl-en-ctl@ml.gentei.org][14] (English). Use `subscribe YOUR NAME` as subject +and body. To unsubscribe, use `unsubscribe` as body. To get help, use `# guide` +as body. + + +Development +=========== + +Fork it on [GitHub][15]. + + +[1]: http://en.wikipedia.org/wiki/Internet_Message_Access_Protocol + +[2]: http://www.gnu.org/software/emacs/ + +[3]: mailto:teranisi@gohome.org + +[4]: http://www.emacswiki.org/emacs/WanderLust + +[5]: http://tools.ietf.org/html/rfc2060 "M. Crispin, 'INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1', RFC 2060, 1996" + +[6]: http://tools.ietf.org/html/rfc977 "B. Kantor and P. Lapsley, 'Network News Transfer Protocol: A Proposed Standard for the Stream-Based Transmission of News', RFC 977, 1986" + +[7]: http://tools.ietf.org/html/rfc1939 "J. Myers, M. Rose, 'Post Office Protocol - Version 3', RFC 1939, 1996" + +[8]: http://www.mew.org/ "'Mew - Messaging in the Emacs World', (Copyright (C) 1994, 1995, 1996, 1997, 1998 Mew developing team)" + +[9]: mailto:wl-en@ml.gentei.org + +[10]: http://news.gmane.org/gmane.mail.wanderlust.general + +[11]: wl@ml.gentei.org + +[12]: http://news.gmane.org/gmane.mail.wanderlust.general.japanese + +[13]: mailto:wl-ctl@ml.gentei.org + +[14]: mailto:wl-en-ctl@ml.gentei.org + +[15]: https://github.com/wanderlust/wanderlust