* pces.el: Require `pces-raw' if file-coding feature is not
[elisp/apel.git] / README.en
index 99d964e..2542874 100644 (file)
--- a/README.en
+++ b/README.en
@@ -1,5 +1,4 @@
 [README for APEL (English Version)]
-by MORIOKA Tomohiko <morioka@jaist.ac.jp>
 
 What's APEL?
 ============
@@ -10,9 +9,9 @@ What's APEL?
     poe.el --- emulation module mainly for basic functions and special
               forms/macros of latest emacsen
       poe-xemacs.el  --- for XEmacs
-      poe-19.el             --- for Emacs 19
       poe-18.el             --- for Emacs 18/Nemacs
          env.el      --- env.el for Emacs 18
+      localhook.el   --- hook functions for Emacs 19.28 and earlier.
 
     poem.el --- provide basic functions to write portable MULE
                programs
@@ -24,6 +23,11 @@ What's APEL?
       poem-e20_3.el  --- for Emacs 20.3
       poem-xm.el     --- for XEmacs-MULE
 
+    invisible.el --- provide features about invisible region
+      inv-18.el     --- for Emacs 18
+      inv-19.el     --- for Emacs 19
+      inv-xemacs.el --- for XEmacs
+
     mcharset.el --- provide MIME charset related features
       mcs-nemacs.el --- for Nemacs
       mcs-ltn1.el   --- for Emacs 19/XEmacs without MULE
@@ -32,19 +36,13 @@ What's APEL?
       mcs-e20.el    --- for Emacs 20
       mcs-xm.el     --- for XEmacs-MULE
 
-    pccl.el --- utility to write portable CCL program
-      pccl-om.el --- for MULE 1.*, 2.*
-      pccl-20.el --- for Emacs 20/XEmacs-MULE
+    static.el --- utility for static evaluation
 
-    broken.el --- provide information of broken facilities of Emacs.
+    broken.el --- provide information of broken facilities of Emacs
 
-    emu.el --- (emu bundled in tm-7.106 compatibility module; it
-               required poe, poem and mcharset)
-      emu-mule:        for MULE 1.*, 2.*
-      richtext.el   --- text/richtext module
-                       for Emacs 19.29 or later,
-                           XEmacs 19.14 or later
-      tinyrich.el   --- text/richtext module for old emacsen
+    pccl.el --- utility to write portable CCL program
+      pccl-om.el --- for MULE 2.*
+      pccl-20.el --- for Emacs 20/XEmacs-21-MULE
 
     alist.el: utility for Association-list
 
@@ -59,6 +57,18 @@ What's APEL?
 
     mule-caesar.el: ROT 13-47-48 Caesar rotation utility
 
+    emu.el --- (emu bundled in tm-7.106 compatibility module; it
+               required poe, poem and mcharset)
+      emu-mule:        for MULE 1.*, 2.*
+      richtext.el   --- text/richtext module
+                       for Emacs 19.29 or later,
+                           XEmacs 19.14 or later
+      tinyrich.el   --- text/richtext module for old emacsen
+
+    pcustom.el --- provide portable custom environment
+
+      tinycustom.el --- emulation module of custom.el
+
 
 Installation
 ============
@@ -102,6 +112,22 @@ Installation
        /usr/local/share/emacs/20.2/site-lisp/  --- emu
        /usr/local/share/emacs/site-lisp/apel/  --- APEL
 
+  You can specify the lisp directory for Emacs Lisp programs,
+  for example:
+
+       % make install LISPDIR=~/elisp
+
+  You can also specify the version specific lisp directory where the
+  emu modules will be installed in, for example:
+
+       % make install VERSION_SPECIFIC_LISPDIR=~/elisp
+
+  If you would like to know what files belong to the emu modules or
+  the apel modules, or where they will be installed in, for example,
+  please type the following command.
+
+       % make what-where LISPDIR=~/elisp VERSION_SPECIFIC_LISPDIR=~/elisp
+
   You can specify other optional settings by editing the file
   APEL-CFG.  Please read comments in it.
 
@@ -132,15 +158,15 @@ load-path (for Emacs or MULE)
 =============================
 
   If you are using Emacs or Mule, please add directory of apel to
-  load-path.  If you install by default setting, you can write
-  subdirs.el for example:
+  load-path.  If you install by default setting with Emacs 20.1/20.2,
+  you can write subdirs.el for example:
 
   --------------------------------------------------------------------
   (normal-top-level-add-to-load-path '("apel"))
   --------------------------------------------------------------------
 
-  If you are using XEmacs, there are no need of setting about
-  load-path.
+  If you are using Emacs 20.3 or later or XEmacs, there are no need to
+  set up load-path with normal installation.
 
 
 How to use
@@ -186,7 +212,7 @@ Function add-path (PATH &rest OPTIONS)
   You can use following PATH styles:
 
     load-path relative: "PATH" (it is searched from
-                               `defaul-load-path')
+                               `default-load-path')
 
     home directory relative: "~/PATH" "~USER/PATH"
 
@@ -209,7 +235,7 @@ Function add-latest-path (PATTERN &optional ALL-PATHS)
   and if bbdb-1.51 is newer than bbdb-1.50, and site-lisp is
   /usr/local/share/emacs/site-lisp,
 
-       (add-path "bbdb")
+       (add-latest-path "bbdb")
 
   it adds "/usr/local/share/emacs/site-lisp/bbdb-1.51" to top of
   `load-path'.
@@ -237,12 +263,12 @@ Function file-installed-p (FILE &optional PATHS)
 Function exec-installed-p (FILE &optional PATHS SUFFIXES)
 
   Return absolute-path of FILE if FILE exists in PATHS.  If PATHS is
-  omitted, `exec-path' is used.  If suffixes is omitted,
+  omitted, `exec-path' is used.  If SUFFIXES is omitted,
   `exec-suffix-list' is used.
 
 Function module-installed-p (MODULE &optional PATHS)
 
-  Return non-nil if module is provided or exists in PATHS.  If PATHS
+  Return non-nil if MODULE is provided or exists in PATHS.  If PATHS
   is omitted, `load-path' is used.
 
 filename
@@ -280,3 +306,38 @@ Bug reports
 
        tm-en-help@chamonix.jaist.ac.jp (English)
        tm-ja-help@chamonix.jaist.ac.jp (Japanese)
+
+
+Anonymous FTP
+=============
+
+  Latest release of APEL can be obtained from:
+
+    ftp://ftp.etl.go.jp/pub/mule/apel/
+
+
+CVS
+===
+
+  Development of APEL uses CVS.  So latest developing version is
+  available at CVS.
+
+(0) cvs login (first time only)
+
+    % cvs -d :pserver:anonymous@chamonix.jaist.ac.jp:/hare/cvs/root \
+       login
+
+    CVS password: [CR] # NULL string
+
+(1) checkout
+
+    % cvs -d :pserver:anonymous@chamonix.jaist.ac.jp:/hare/cvs/root \
+       checkout apel
+
+
+  If you would like to join CVS based development, please send mail to
+
+       cvs@chamonix.jaist.ac.jp
+
+  with your account name and UNIX /etc/passwd style crypted password.
+  We hope you will join the open development.