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