*** empty log message ***
[m17n/m17n-lib.git] / README
diff --git a/README b/README
index 9fbd9fb..c6bbd2d 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
-This directory tree holds version 1.3.0 of the m17n library.   -*- text -*-
+This directory tree holds version 1.6.3 of the m17n library.   -*- text -*-
 
 
-Copyright (C) 2003, 2004, 2005
+Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
   National Institute of Advanced Industrial Science and Technology (AIST)
   Registration Number H15PRO112
 See the end for copying conditions.
   National Institute of Advanced Industrial Science and Technology (AIST)
   Registration Number H15PRO112
 See the end for copying conditions.
@@ -14,11 +14,27 @@ language.
 (1-1) From CVS working directory.
 
 Run the script "bootstrap.sh" in this directory.  It is tested that
 (1-1) From CVS working directory.
 
 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
+the script runs successfully with these versions of tools.
+
+               libtool automake autoconf gettext pkg-config
+  Ubunto 9.10    2.2.6b   1.11.1     2.66    0.17       0.22
+  Ubunto 10.4    2.2.6b   1.11.1     2.65    0.17       0.22
+
+(*1) bootstrap.sh prints lots of warning something like this:
+------------------------------------------------------------
+autoreconf: running: aclocal --force -I m4
+configure.ac:47: warning: AC_COMPILE_IFELSE was called \
+before AC_USE_SYSTEM_EXTENSIONS
+../../lib/autoconf/specific.m4:389: AC_USE_SYSTEM_EXTENSIONS is expanded from...
+m4/lock.m4:29: gl_LOCK_EARLY_BODY is expanded from...
+m4/lock.m4:22: gl_LOCK_EARLY is expanded from...
+m4/lock.m4:253: gl_LOCK is expanded from...
+m4/intl.m4:186: gt_INTL_SUBDIR_CORE is expanded from...
+m4/intl.m4:25: AM_INTL_SUBDIR is expanded from...
+m4/gettext.m4:57: AM_GNU_GETTEXT is expanded from...
+configure.ac:47: the top level
+------------------------------------------------------------
+but, it seems that they can be just ignored.
 
 Then, proceed to the next step.
 
 
 Then, proceed to the next step.
 
@@ -34,12 +50,12 @@ will find out the existence of them automatically.
        libotf          -- http://www.m17n.org/libotf/
        fontconfig      -- http://freedesktop.org/Software/fontconfig
        xft             -- http://freedesktop.org/Software/Xft
        libotf          -- http://www.m17n.org/libotf/
        fontconfig      -- http://freedesktop.org/Software/fontconfig
        xft             -- http://freedesktop.org/Software/Xft
-       gd              -- http://www.boutell.com/gd/http/gd-1.8.4.tar.gz
+       gd              -- http://www.boutell.com/gd/
 
 In addition, for finding a word boundary in Thai text, "configure"
 checks the existence of these libraries (libthai is preferred):
 
 
 In addition, for finding a word boundary in Thai text, "configure"
 checks the existence of these libraries (libthai is preferred):
 
-       libthai         -- http://
+       libthai         -- http://sourceforge.net/projects/libthai
        wordcut         -- http://thaiwordseg.sourceforge.net/
 
 The sample program m17n-edit utilizes this Japanese inputting system.
        wordcut         -- http://thaiwordseg.sourceforge.net/
 
 The sample program m17n-edit utilizes this Japanese inputting system.
@@ -58,17 +74,27 @@ will not compile with an old-style K&R compiler.
 
 The default installation path is "/usr/local".
 Thus, these header files are installed in /usr/local/include:
 
 The default installation path is "/usr/local".
 Thus, these header files are installed in /usr/local/include:
-       m17n-core.h, m17n.h, m17n-gui.h, m17n-err.h, m17n-X.h
+       m17n-core.h, m17n.h, m17n-gui.h, m17n-err.h, m17n-X.h, m17n-flt.h
+
 These library files are installed in /usr/local/lib:
        libm17n-core.{a,so*,la}
        libm17n.{a,so*,la}
        libm17n-gui.{a,so*,la}
 These library files are installed in /usr/local/lib:
        libm17n-core.{a,so*,la}
        libm17n.{a,so*,la}
        libm17n-gui.{a,so*,la}
+       libm17n-flt.{a,so*,la}
+
+These modules are installed in /usr/local/lib/m17n/1.0:
        libm17n-X.{a,so*,la}
        libm17n-gd.{a,so*,la}
        libimx-anthy.{a,so*,la},
        libimx-ispell.{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
 This shell script is installed in /usr/local/bin:
        m17n-config
+
+These pkgconfig metadata files are installed in
+/usr/local/lib/pkgconfig:
+       m17n-core.pc, m17n-shell.pc, m17n-flt.pc, m17n-gui.pc
+
 These sample programs are installed in /usr/local/bin too:
        m17n-conv, m17n-date, m17n-view, m17n-dump, m17n-edit
 
 These sample programs are installed in /usr/local/bin too:
        m17n-conv, m17n-date, m17n-view, m17n-dump, m17n-edit
 
@@ -78,7 +104,7 @@ instruct the `configure' script not to build them as below:
        % ./configure --without-gui
 
 This file under `example' sub-directory is a Japanese resource file
        % ./configure --without-gui
 
 This file under `example' sub-directory is a Japanese resource file
-for medit.  It is not installed but useful in Japanese locale.  Copy
+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:
 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:
@@ -98,7 +124,7 @@ Please read also INSTALL for the generic installation instructions.
 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
 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.0 or the later is required) too before you try the
+install it (Ver.1.4.0 or the later is required) too before you try the
 above sample programs or develop a program that uses the m17n library.
 
 
 above sample programs or develop a program that uses the m17n library.
 
 
@@ -116,8 +142,12 @@ parallel.
 
 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
 
 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.
+for GUI API, include <m17n-gui.h >.  In addition, for those who need
+only text shaping facility that uses FLT (Font Layout Table), the
+library provides FLT API.  To use it, include <m17n-flt.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
 
 The shell script "m17n-config" helps compiling and linking of a
 program that uses the m17n library.  For instance this compiles PROG.c
@@ -133,7 +163,7 @@ This compiles PROX.c that uses GUI API and builds executable PROX.
 ----------------------------------------------------------------------
 Copyright information
 
 ----------------------------------------------------------------------
 Copyright information
 
-Copyright (C) 2003, 2004, 2005
+Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
   National Institute of Advanced Industrial Science and Technology (AIST)
   Registration Number H15PRO112
 
   National Institute of Advanced Industrial Science and Technology (AIST)
   Registration Number H15PRO112
 
@@ -151,5 +181,5 @@ 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
 
 You should have received a copy of the GNU Lesser General Public
 License along with the m17n library; if not, write to the Free
-Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-02111-1307, USA.
+Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA.