Copyright notice fixed.
[m17n/m17n-pango.git] / README
diff --git a/README b/README
index 02e3915..86a8ded 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,13 @@
-This directory tree holds version 0.9.0 of m17n-pango. -*- text -*-
+This directory holds version 0.9.1 of pango-m17n.              -*- text -*-
 
 Copyright (C) 2006
   National Institute of Advanced Industrial Science and Technology (AIST)
-  Registration Number H15PRO112
+  Registration Number H16PRO276
 See the end for copying conditions.
 
-This package "m17n-pango" provides a Pango shaping module for various
-scripts that requires CTL (Complex Text Layout) language.  It utilizes
-the rendering capability of the m17n library.
+This package "pango-m17n" provides a single Pango shaping module for
+various scripts that requires CTL (Complex Text Layout) language.  It
+utilizes the rendering capability of the m17n library.
 
 
 (1) INSTALLATION
@@ -17,16 +17,16 @@ the rendering capability of the m17n library.
 Run the script "bootstrap.sh" in this directory.  It is tested that
 the script run successfully with these versions of autotools.
 
-       libtool-1.5.6
-       automake-1.9.5
-       autoconf-2.59
+       libtool-1.5.22
+       automake-1.9.6
+       autoconf-2.60
 
 Then, proceed to the next step.
 
 (1-2) From the tarball.
 
 It requires Pango (ver.1.4 or the later) and the m17n library
-(ver.1.3.3 or the later).
+(ver.1.3.4 or the later).
 
 Type the followings on the command line.
 
@@ -35,99 +35,43 @@ Type the followings on the command line.
        % make install
 
 The default installation path is "/usr/local".
-Thus, this loadable module is installed in /usr/local/lib/m17n-pango/1.4.0/modules
-       m17n-core.h, m17n.h, m17n-gui.h, m17n-err.h, m17n-X.h
-These library files are installed in /usr/local/lib:
-       libm17n-core.{a,so*,la}
-       libm17n.{a,so*,la}
-       libm17n-gui.{a,so*,la}
-       libm17n-X.{a,so*,la}
-       libm17n-gd.{a,so*,la}
-       libimx-anthy.{a,so*,la},
-       libimx-ispell.{a,so*,la},
-This shell script is installed in /usr/local/bin:
-       m17n-config
-These sample programs are installed in /usr/local/bin too:
-       m17n-conv, m17n-date, m17n-view, m17n-dump, m17n-edit
-
-If you don't need GUI libraries (libm17n-gui.so and etc.), you can
-instruct the `configure' script not to build them as below:
-
-       % ./configure --without-gui
-
-This file under `example' sub-directory is a Japanese resource file
-for m17n-edit.  It is not installed but useful in Japanese locale.  Copy
-it to your home directory (or, for instance,
-/usr/X11R6/lib/X11/ja/app-defaults) and rename it to "M17NEdit" if you
-want to see labels in Japanese:
-       M17NEdit.ja
-
-These text files under `example' sub-directory are not installed but
-useful for testing the rendering engine of the m17n library:
-       HELLO.utf8 HELLO.xml HELLO-ja.utf8 HELLO-ja.xml HELLO.html
-XXX.xml are generated from XXX.utf8 by attaching text property
-`language' and serializing.
 
 Please read also INSTALL for the generic installation instructions.
 
 
-(2) DATABASE
+(2) USAGE
 
-The m17n library utilizes the m17n database available at:
-       http://www.m17n.org/m17n-lib/m17n-db
-Without this database, the m17n library loses half its value.  Please
-install it (Ver.1.3.3 or the later is required) too before you try the
-above sample programs or develop a program that uses the m17n library.
+If you want to use this pango module (shaper engine), do something
+like this:
 
+% PANGO_RC_FILE=/usr/local/lib/pango-m17n/pangorc gedit
 
-(3) DOCUMENTATION
+To check if this module is surely being used, do this:
 
-This page has a link to full documentation of the m17n library:
-       http://www.m17n.org/m17n-lib
-
-Actually, the documentation was generated by Doxygen using comments in
-the source files.  There are English and Japanese comments in
-parallel.
-
-
-(4) USAGE
-
-The library provides three levels of APIs, CORE, SHELL, and GUI.  For
-CORE API, include <m17n-core.h>, for SHELL API, include <m17n.h>, and
-for GUI API, include <m17n-gui.h >.  See the documentation above, or
-the manual of m17nIntro(3) for more detail.
-
-The shell script "m17n-config" helps compiling and linking of a
-program that uses the m17n library.  For instance this compiles PROG.c
-that uses SHELL API and builds executable PROG.
-
-       % gcc -o PROG `m17n-config --cflags` `m17n-config --libs` PROG.c
-
-This compiles PROX.c that uses GUI API and builds executable PROX.
-
-       % gcc -o PROX `m17n-config GUI --cflags` `m17n-config GUI --libs` PROX.c
+% MDEBUG_FONT=1 PANGO_RC_FILE=/usr/local/lib/pango-m17n/pangorc gedit
 
+Then, the information about which font is being used is printed.
 
 ----------------------------------------------------------------------
 Copyright information
 
 Copyright (C) 2006
   National Institute of Advanced Industrial Science and Technology (AIST)
-  Registration Number H15PRO112
+  Registration Number H16PRO276
 
-This file is part of m17n-pango; a sub-part of the m17n library.
+This file is part of pango-m17n library.
 
-The m17n library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public License
-as published by the Free Software Foundation; either version 2.1 of
-the License, or (at your option) any later version.
+The pango-m17n library is free software; you can redistribute it
+and/or modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either version
+2.1 of the License, or (at your option) any later version.
 
-The m17n library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
+The pango-m17n library is distributed in the hope that it will be
+useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Lesser General Public License for more details.
 
 You should have received a copy of the GNU Lesser General Public
-License along with the m17n library; if not, write to the Free
+License along with the pango-m17n library; if not, write to the Free
 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 02111-1307, USA.