(eword-decode-string, eword-decode-region): Mention language info in doc string.
[elisp/flim.git] / README.en
index 74bf582..c3c0d3f 100644 (file)
--- a/README.en
+++ b/README.en
@@ -1,4 +1,5 @@
 [README for FLIM (English Version)]
+by MORIOKA Tomohiko
 
 What's FLIM
 ===========
@@ -9,34 +10,44 @@ 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
+      mime-def.el --- Definitions about MIME format
 
-       mime-parse.el --- MIME parser
+      mime-parse.el --- MIME parser
 
-       mel.el --- MIME encoder/decoder
-           mel-dl.el --- base64 (b-encoding) encoder/decoder
-                         (for Emacs 20 with dynamic loading support)
-           mel-b.el  --- base64 (b-encoding) encoder/decoder
-                         (for other emacsen)
-           mel-q.el  --- quoted-printable and q-encoding encoder/decoder
-           mel-u.el  --- unofficial module for uuencode
-           mel-g.el  --- unofficial module for gzip64
+      mel.el --- MIME encoder/decoder
+       mel-b-dl.el --- base64 (B-encoding) encoder/decoder
+                       (for Emacs 20 with dynamic loading support)
+       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-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
+      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 package.  APEL package
-    is available at:
+(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
 
@@ -47,7 +58,7 @@ Installation
 
   You can specify the emacs command name, for example
 
-       % make install EMACS=xemacs
+       % make EMACS=xemacs
 
   If `EMACS=...' is omitted, EMACS=emacs is used.
 
@@ -64,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=~/
 
@@ -84,37 +95,55 @@ Installation
   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
   /usr/local/lib/xemacs/site-lisp).
 
+  If the emu modules (included in APEL package) have been installed in
+  the non-standard directory, you should specify where they will be
+  found, for example:
+
+       % 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.
 
+(1-c) install as a XEmacs package
+
+  If you want to install to XEmacs package directory, please do
+  following:
+
+       % make install-package
+
+  You can specify the XEmacs command name, for example
+
+       % make install-package XEMACS=xemacs-21
+
+  If `XEMACS=...' is omitted, XEMACS=xemacs is used.
 
-load-path (for Emacs or MULE)
-=============================
+  You can specify the package directory, for example:
 
-  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:
+       % make install PACKAGEDIR=~/.xemacs
 
-  --------------------------------------------------------------------
-  (normal-top-level-add-to-load-path '("apel" "flim"))
-  --------------------------------------------------------------------
+  If `PACKAGEDIR=...' is omitted, the first existing package
+  directory is used.
 
-  If you are using XEmacs, there are no need of setting about
-  load-path.
+  Notice that XEmacs package system requires XEmacs 21.0 or later.
 
 
 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 List:
 
-       bug-tm-en@chamonix.jaist.ac.jp  (English)
-       bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
+       emacs-mime-en@m17n.org  (English)
+       emacs-mime-ja@m17n.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, send an empty e-mail to
 
-       tm-en-help@chamonix.jaist.ac.jp (English)
-       tm-ja-help@chamonix.jaist.ac.jp (Japanese)
+       emacs-mime-en-ctl@m17n.org      (English)
+       emacs-mime-ja-ctl@m17n.org      (Japanese)