INSTALL

   1 -*- mode: text; left-margin: 2; fill-column: 70; -*-
   2
   3   This program is in very early developing stage. Please use at your
   4   own risk.
   5
   6 * Requirements
   7
   8   Liece works under following environment at least.
   9
  10   - Emacs 20.6
  11   - XEmacs 21.2 with MULE extension
  12
  13   This package uses following external libraries.
  14
  15   - APEL 10.2 or later (stands for - "A Portable Emacs Library")
  16        ftp://ftp.m17n.org/pub/mule/apel/
  17   - FLIM 1.12 or later
  18        ftp://ftp.m17n.org/pub/mule/flim/
  19
  20   If you does not have installed copy of above, please try to specify
  21   `--enable-apel' option at configure time.
  22   (After configuration, Liece will use local copy of APEL.)
  23
  24 * Quick installation
  25
  26   (Install APEL, then)
  27   % ./configure
  28   % make
  29   % su
  30   Password: ultrasecret
  31   # make install
  32
  33   If you are not able to become super-user, you may specify local
  34   directory to install.
  35
  36   % ./configure --prefix=~/ --with-lispdir=~/elisp
  37
  38 * Configuration and running
  39
  40 ** Setting up your ~/.emacs
  41
  42   If you are using Emacs or Mule, please add directory of APEL and
  43   Liece to load-path.  If you install by default setting you can write
  44   subdirs.el for example:
  45
  46   ex:
  47   (normal-top-level-add-to-load-path '("apel" "liece"))
  48
  49   If you are using Emacs 20.3 or XEmacs, prepare `subdirs.el' with
  50   following contents, Emacs will find and append each substantial
  51   directory to `load-path' automagically.
  52
  53   ex:
  54   (normal-top-level-add-subdirs-to-load-path)
  55
  56   If you are using Emacs 19 or earlier version of Emacsen,
  57   you have to write more complicated path-setting in your `~/.emacs'.
  58
  59   ex:
  60   (setq load-path
  61         (append
  62          (list "/usr/local/lib/mule/site-lisp/apel"
  63                "/usr/local/lib/mule/site-lisp/liece")
  64          load-path))
  65
  66   For more details, please read `README' file come along with APEL.
  67
  68   If you have never been using liece and/or its variants,
  69   add an autoload setting into your `~/.emacs'.
  70
  71   ex:
  72   (autoload 'liece "liece" nil t)
  73
  74 ** Setting up your ~/.liece/init.el
  75
  76   If you have never run Liece, and quite unsure to configure startup
  77   files in Emacs Lisp, please copy `sample.dot.emacs' file to `~/.liece/init.el'.
  78
  79 * Optional packages
  80
  81   Following packages are optional. If install script of this package
  82   found them, it would use various functionality provided in them.
  83
  84   custom
  85         http://www.dina.kvl.dk/~abraham/custom/
  86
  87   X-Face utility
  88         ftp://ftp.jpl.org/pub/elisp/
  89
  90   bitmap-mule
  91         ftp://ftp.jpl.org/pub/elisp/bitmap/ (for GNU Emacs only)