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.7
  11   - XEmacs 21.4 or later
  12
  13   This package uses following 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 * Quick installation
  21
  22   (Install APEL, then)
  23   % ./configure
  24   % make
  25   % su
  26   Password:
  27   # make install
  28
  29   If you are not able to become super-user, you may specify local
  30   directory to install.
  31
  32   % ./configure --prefix=~/ --with-lispdir=~/elisp
  33
  34 * Configuration and running
  35
  36 ** Setting up your ~/.emacs
  37
  38   If you are using Emacs or Mule, please add directory of APEL and
  39   Liece to load-path.  If you install by default setting you can write
  40   subdirs.el for example:
  41
  42   ex:
  43   (normal-top-level-add-to-load-path '("apel" "liece"))
  44
  45   If you are using Emacs 20.3 or XEmacs, prepare `subdirs.el' with
  46   following contents, Emacs will find and append each substantial
  47   directory to `load-path' automagically.
  48
  49   ex:
  50   (normal-top-level-add-subdirs-to-load-path)
  51
  52   If you are using Emacs 19 or earlier version of Emacsen,
  53   you have to write more complicated path-setting in your `~/.emacs'.
  54
  55   ex:
  56   (setq load-path
  57         (append
  58          (list "/usr/local/lib/mule/site-lisp/apel"
  59                "/usr/local/lib/mule/site-lisp/liece")
  60          load-path))
  61
  62   For more details, please read `README' file come along with APEL.
  63
  64   If you have never been using liece and/or its variants,
  65   add an autoload setting into your `~/.emacs'.
  66
  67   ex:
  68   (autoload 'liece "liece" nil t)
  69
  70 ** Setting up your ~/.liece/init.el
  71
  72   If you have never run Liece, and quite unsure to configure startup
  73   files in Emacs Lisp, please copy `sample.dot.emacs' file to `~/.liece/init.el'.
  74
  75 * Optional packages
  76
  77   Following packages are optional. If install script of this package
  78   found them, it would use various functionality provided by them.
  79
  80   custom
  81         http://www.dina.kvl.dk/~abraham/custom/
  82
  83   X-Face utility
  84         ftp://ftp.jpl.org/pub/elisp/
  85
  86   bitmap-mule
  87         ftp://ftp.jpl.org/pub/elisp/bitmap/ (for GNU Emacs only)