update.
[elisp/flim.git] / README.en
index 004fbe3..613e2d5 100644 (file)
--- a/README.en
+++ b/README.en
@@ -1,4 +1,5 @@
 [README for FLIM (English Version)]
+by MORIOKA Tomohiko
 
 What's FLIM
 ===========
@@ -9,7 +10,7 @@ What's FLIM
 
     std11.el   --- STD 11 (RFC 822) parser and utility
 
-    mime.el    --- MIME library
+    mime.el    --- to provide various services about MIME-entities
 
       mime-def.el --- Definitions about MIME format
 
@@ -18,28 +19,35 @@ What's FLIM
       mel.el --- MIME encoder/decoder
        mel-b-dl.el --- base64 (B-encoding) encoder/decoder
                        (for Emacs 20 with dynamic loading support)
-       mel-b.el    --- base64 (B-encoding) encoder/decoder
+       mel-b-ccl.el --- base64 (B-encoding) encoder/decoder
+                        (using CCL)
+       mel-b-en.el --- base64 (B-encoding) encoder/decoder
                        (for other emacsen)
+       mel-q-ccl.el --- quoted-printable and Q-encoding
+                        encoder/decoder (using CCL)
        mel-q.el    --- quoted-printable and Q-encoding
                        encoder/decoder
-       mel-ccl.el  --- base64 (B-encoding), quoted-printable and
-                       Q-encoding encoder/decoder using CCL
-       mel-u.el    --- unofficial module for uuencode
-       mel-g.el    --- unofficial module for gzip64
+       mel-u.el    --- unofficial backend for uuencode
+       mel-g.el    --- unofficial backend for gzip64
 
       eword-decode.el --- encoded-word decoder
       eword-encode.el --- encoded-word encoder
 
     mailcap.el --- mailcap parser and utility
 
+  This library should work on:
+
+       Emacs 20.4 and up
+       XEmacs 21.1 and up
+
 
 Installation
 ============
 
-(0) before installing it, please install APEL (9.4 or later) package.
+(0) before installing it, please install APEL (10.7 or later) package.
     APEL package is available at:
 
-       ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
+       ftp://ftp.m17n.org/pub/mule/apel/
 
 (1-a) run in expanded place
 
@@ -67,7 +75,7 @@ Installation
   If `EMACS=...' is omitted, EMACS=emacs is used.
 
   You can specify the prefix of the directory tree for Emacs Lisp
-  programs and shell scripts, for example:
+  programs, for example:
 
        % make install PREFIX=~/
 
@@ -93,6 +101,11 @@ Installation
 
        % make install VERSION_SPECIFIC_LISPDIR=~/elisp
 
+  Following make target is available to find what files are parts of
+  emu / APEL package, and where are directories to install them:
+
+    % make what-where LISPDIR=~/elisp VERSION_SPECIFIC_LISPDIR=~/elisp
+
   You can specify other optional settings by editing the file
   FLIM-CFG.  Please read comments in it.
 
@@ -103,7 +116,7 @@ Installation
 
        % make install-package
 
-  You can specify the emacs command name, for example
+  You can specify the XEmacs command name, for example
 
        % make install-package XEMACS=xemacs-21
 
@@ -119,33 +132,19 @@ Installation
   Notice that XEmacs package system requires XEmacs 21.0 or later.
 
 
-load-path (for Emacs or MULE)
-=============================
-
-  If you are using Emacs or Mule, please add directory of FLIM to
-  load-path.  If you install by default setting, you can write
-  subdirs.el for example:
-
-  --------------------------------------------------------------------
-  (normal-top-level-add-to-load-path '("apel" "flim"))
-  --------------------------------------------------------------------
-
-  If you are using XEmacs, there are no need of setting about
-  load-path.
-
-
 Bug reports
 ===========
 
   If you write bug-reports and/or suggestions for improvement, please
-  send them to the tm Mailing List:
+  send them to the Emacs-MIME Mailing Lists:
 
-       bug-tm-en@chamonix.jaist.ac.jp  (English)
-       bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
+       emacs-mime-en@lists.chise.org   (English)
+       emacs-mime-ja@lists.chise.org   (Japanese)
 
-  Via the tm ML, you can report FLIM bugs, obtain the latest release
-  of FLIM, and discuss future enhancements to FLIM. To join the tm ML,
-  send an empty e-mail to
+  Via the Emacs-MIME ML, you can report FLIM bugs, obtain the latest
+  release of FLIM, and discuss future enhancements to FLIM.  To join
+  the Emacs-MIME ML, please see the descriptions of the following
+  pages:
 
-       tm-en-help@chamonix.jaist.ac.jp (English)
-       tm-ja-help@chamonix.jaist.ac.jp (Japanese)
+      http://lists.chise.org/mailman/listinfo/emacs-mime-en (English)
+      http://lists.chise.org/mailman/listinfo/emacs-mime-ja (Japanese)