X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=README;h=37cf90dafd98e933119bdd8718d45972e2ac2fa0;hb=f1f4aae4d0f7a60b8bcb69915ffde0146ab9715e;hp=82e268eee2f89ce5abd1d7ea410ae9f99ec13e37;hpb=d25b6a1ea3097d827e8b7716e55974cc8c748992;p=m17n%2Fm17n-lib.git diff --git a/README b/README index 82e268e..37cf90d 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -This directory tree holds version 1.0 PL2 of the m17n library. -*- text -*- +This directory tree holds version 1.1.0 of the m17n library. -*- text -*- Copyright (C) 2003, 2004 National Institute of Advanced Industrial Science and Technology (AIST) @@ -13,7 +13,7 @@ language. (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 auto tools. +the script run successfully with these versions of autotools. libtool-1.4 automake-1.4p5 @@ -23,22 +23,25 @@ Then, proceed to the next step. (1-2) From the tarball. -The m17n library utilizes these extra libraries. It is recommened to -install them before running the "configure" script. The script will -find out the existence of them automatically. +The m17n library utilizes these extra libraries. It is recommended to +install all of them before running the "configure" script. The script +will find out the existence of them automatically. libxml2 -- http://xmlsoft.org/ fribidi -- http://fribidi.sourceforge.net/ freetype -- http://www.freetype.org/ 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 The sample program medit utilizes this Japanese inputting system. It -is also recommened to install it. +is also recommended to install it. anthy -- http://anthy.sourceforge.jp/ The sample program medit and mdump utilize this Thai word-boundary -finder. It is also recommened to install it. +finder. It is also recommended to install it. wordcut -- http://thaiwordseg.sourceforge.net/ @@ -53,13 +56,15 @@ 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: - m17n.h, m17n-core.h, m17n-gui.h, m17n-err.h, m17n-X.h + m17n-core.h, m17n.h, m17n-gui.h, m17n-err.h, m17n-X.h These library files are installed in /usr/local/lib: - libm17n.{a,so,la} - libm17n-core.{a,so,la} - libm17n-X.{a,so,la} - libimx-anthy.{a,so,la}, - libimx-ispell.{a,so,la}, + 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: @@ -76,14 +81,14 @@ 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 XXX.xml are generated from XXX.utf8 by attaching text property -`langauge' and serializing. +`language' and serializing. Please read also INSTALL for the generic installation instructions. (2) DATABASE -The m17n library utilizes the m17n database avairable at: +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 too before you try the above sample programs or develop a @@ -92,26 +97,29 @@ program that uses the m17n library. (3) DOCUMENTATION -This page has a link to full documentaion of the m17n library: +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, but plese note that Japanese comments are not updated for -long. +parallel. (4) USAGE The library provides three levels of APIs, CORE, SHELL, and GUI. For CORE API, include , for SHELL API, include , and -for GUI API, include and . See the -documementation above, or the manual of m17nIntro(3) for more detail. +for GUI API, include . 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 --clags` `m17n-config --libs` PROG.c + % 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 ---------------------------------------------------------------------- Copyright information