* Sync up with semi-1_13_4.
[elisp/semi.git] / README.en
index a56a0c4..363cc58 100644 (file)
--- a/README.en
+++ b/README.en
@@ -1,8 +1,7 @@
 [README for SEMI kernel package (English Version)]
-by MORIOKA Tomohiko <morioka@jaist.ac.jp>
 
 What's SEMI?
-------------
+============
 
   SEMI is a library to provide MIME feature for GNU Emacs.  MIME is a
   proposed internet standard for including content and headers other
@@ -33,7 +32,7 @@ What's SEMI?
 
 
 Required environment
---------------------
+====================
 
   SEMI supports XEmacs 20.2 or later with mule, and Emacs 20.
 
@@ -41,13 +40,9 @@ Required environment
   19.14.  SEMI also does not support Emacs 19.29 to 19.34, XEmacs
   19.15 or XEmacs 20.2 without mule, but SEMI may work with them.
 
-  If you use Emacs 20, don't set `enable-multibyte-characters' to
-  nil. (Maybe non mule setting requires to modify emu.  In addition,
-  it is better to use terminal-coding-system feature)
-
-  SEMI requires APEL (8.7 or later) and FLIM (1.1.0 or later) package.
-  Please install them before installing it.  APEL package is available
-  at:
+  SEMI requires APEL (9.11 or later) and FLIM (1.12.5 or later)
+  package.  Please install them before installing it.  APEL package is
+  available at:
 
        ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
 
@@ -57,13 +52,26 @@ Required environment
 
   PGP/MIME and application/pgp require mailcrypt or tiny-pgp package.
 
-  The package enriched.el is required to compose text/enriched, so if
-  you use Emacs anything 19.28 or older (including official version of
-  MULE 2.3), WYSIWYG composing for text/enriched is not available.
-
 
 Installation
-------------
+============
+
+(a) run in expanded place
+
+  If you don't want to install other directories, please do only
+  following:
+
+       % make
+
+  You can specify the emacs command name, for example
+
+       % make EMACS=xemacs
+
+  If `EMACS=...' is omitted, EMACS=emacs is used.
+
+(b) make install
+
+  If you want to install other directories, please do following:
 
        % make install
 
@@ -97,13 +105,43 @@ 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
+
+(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 emacs command name, for example
+
+       % make install-package XEMACS=xemacs-21
+
+  If `XEMACS=...' is omitted, XEMACS=xemacs is used.
+
+  You can specify the package directory, for example:
+
+       % make install PACKAGEDIR=~/.xemacs
+
+  If `PACKAGEDIR=...' is omitted, the first existing package
+  directory is used.
+
+  Notice that XEmacs package system requires XEmacs 21.0 or later.
+
+(a,b,c)
+
   You can specify other optional settings by editing the file
   ${archive}/SEMI-CFG.  Please read ${archive}/README.en and comments
   in ${archive}/SEMI-CFG.
 
 
 Initialization
---------------
+==============
 
 (a) load-path
 
@@ -127,7 +165,7 @@ Initialization
 
 
 Documentation
--------------
+=============
 
   To get started, please read ${archive}/README.en.
 
@@ -137,8 +175,8 @@ Documentation
        ftp://ftp.merit.edu/internet/documents/rfc/
 
 
-Bug reports
------------
+Mailing lists
+=============
 
   If you write bug-reports and/or suggestions for improvement, please
   send them to the tm Mailing List:
@@ -152,3 +190,61 @@ Bug reports
 
        tm-en-help@chamonix.jaist.ac.jp (English)
        tm-ja-help@chamonix.jaist.ac.jp (Japanese)
+
+  Notice that you should not send mail to author(s), such as
+  morioka@jaist.ac.jp, directly.  Because your problem may occur in
+  other environments (if not, it might be your problem, not bug of
+  SEMI).  We should discuss in the tm mailing lists.  Anyway
+  direct-mail for authors might be ignored.  Please send mail to the
+  tm mailing lists.
+
+
+CVS based development
+=====================
+
+  If you would like to join CVS based development, please send mail to
+
+       cvs@chamonix.jaist.ac.jp
+
+  with your account name and UNIX style crypted password.  We hope you 
+  will join the open development.
+
+
+Authors
+=======
+
+Original authors
+
+    MORIOKA Tomohiko <morioka@jaist.ac.jp>
+       (the author of mime-view and various parts of SEMI)
+    UMEDA Masanobu <umerin@mse.kyutech.ac.jp>
+       (the author of mime.el of emacs-mime-tools.  mime.el is the
+       origin of mime-edit.el of SEMI)
+
+Other authors
+
+    Shuhei KOBAYASHI  <shuhei-k@jaist.ac.jp>
+       (a major author of signature.el and a lot of codes)
+    MASUTANI Yasuhiro <masutani@me.es.osaka-u.ac.jp>
+       (anonymous ftp codes of mime-play.el)
+    OKABE Yasuo <okabe@kudpc.kyoto-u.ac.jp>
+       (a major author of mime-partial.el and signature.el)
+
+    Steinar Bang <sb@metis.no>
+    Steven L. Baur <steve@miranova.com>
+    Kevin Broadey <KevinB@bartley.demon.co.uk>
+    Alastair Burt <burt@dfki.uni-kl.de>
+    Eric Ding <ericding@San-Jose.ate.slb.com>
+    Thierry Emery <Thierry.Emery@aar.alcatel-alsthom.fr>
+    Simon Josefsson <jas@pdc.kth.se>
+    Jens Lautenbacher <jtl@tkm.physik.uni-karlsruhe.de>
+    Carsten Leonhardt <leo@arioch.tng.oche.de>
+    Pekka Marjola <marjola@bilbo.ntc.nokia.com>
+    Hisashi Miyashita <himi@bird.scphys.kyoto-u.ac.jp>
+    Kazuhiro Ohta <ohta@ele.cst.nihon-u.ac.jp>
+    Alexandre Oliva <oliva@dcc.unicamp.br>
+    François Pinard <pinard@iro.umontreal.ca>
+    Artur Pioro <artur@flugor.if.uj.edu.pl>
+    Dan Rich <drich@morpheus.corp.sgi.com>
+        (contribute to evolve mime-image.el with XEmacs)
+    Katsumi Yamaoka <yamaoka@jpl.org>