*** empty log message ***
[m17n/m17n-pango.git] / README
diff --git a/README b/README
index c9e6412..95430ca 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.4 of pango-m17n.              -*- text -*-
 
-Copyright (C) 2006
+Copyright (C) 2006, 2007, 2008
   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).
+It requires Pango (ver.1.6 or the later) and the m17n library
+(ver.1.5.1 or the later).
 
 Type the followings on the command line.
 
@@ -41,37 +41,41 @@ Please read also INSTALL for the generic installation instructions.
 
 (2) USAGE
 
-If you want to use this pango module (shaper engine), do something
-like this:
+To use this pango module (shaper engine), you have to set two
+environment variables as this:
 
-% PANGO_RC_FILE=/usr/local/lib/m17n-pango/1.4.0/modules/pangorc gedit
+% export PANGO_RC_FILE=/usr/local/lib/pango-m17n/pangorc.m17n
+% export PANGO_USE_M17N=1
 
-To check if this module is surely being used, do this:
+You can also set various MDEBUG_XXX environment variables (handled by
+the m17n library) to check what is going on.  For instance, when you
+run gedit as this:
 
-% MDEBUG_FONT=1 PANGO_RC_FILE=/usr/local/lib/m17n-pango/1.4.0/modules/pangorc gedit
+% MDEBUG_FLT=1 gedit SOME_FILE
 
-Then, the information about which font is being used is printed.
+you'll see the debugging information about how Complex Text Layouting
+is working (if SOME_FILE contains, for instance, Indic text).
 
 ----------------------------------------------------------------------
 Copyright information
 
-Copyright (C) 2006
+Copyright (C) 2006, 2007, 2008
   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.