Make source clean.

[chise/kage.git] / kagecgi / README.en

diff --git a/kagecgi/README.en b/kagecgi/README.en
index 26f7f5a..d1ccb74 100644 (file)
--- a/kagecgi/README.en
+++ b/kagecgi/README.en
@@ -1,4 +1,6 @@
-KAGE/cgi is a Kanji-glyph generating engine call from httpd server.
+KAGE/cgi is a Kanji-glyph generating engine.
+
+It can use by command prompt and for executable cgi for httpd server.
 
 
 PREREQUISITES
@@ -6,10 +8,8 @@ PREREQUISITES
 
 KAGE/cgi needs following librarys:
 
- - Berkely DB 2 (3 is not supported yet)
+ - Berkely DB 4
  - libpng
- - glib
- - xlib
 
 
 CONFIGURATION
@@ -31,23 +31,33 @@ INSTALLING
 
 1) Engine program
 
-After running `make', `kage.cgi' will appear at current directory.
-
-Please copy the file to proper directory.
+  # make install
 
-(Configure httpd for enable excuting .cgi files)
+  (by default, it will be installed as /usr/local/bin/kage.cgi)
 
-2) Parts database
+ Also, if you need to use as cgi, copy/make symbolic link to proper directory.
+ (ex. % cp /usr/local/bin/kage.cgi /var/www/cgi-bin/)
+ 
+2) Parts database (wget is required)
 
-Get database file. (URL `http://fonts.jp/kagedb/wiki')
+  # make database
 
-Copy to proper directory describing at `kagecgi.h'(databeseFileName).
+  (by default, it will be installed as /usr/local/share/kagecgi/kagedb) 
 
 
 TEST
 ====
 
-Call engine from a web browser like as `http://hoge.hoge/kage.cgi?u4e00'.
+1) Run from command prompt
+
+ - % kage.cgi u2ff0.u6c35.u6c38 > result.png
+ - % kage.cgi u4e08-k > result.png
+ - % kage.cgi 'u7389&shotai=gothic' > result.png
+ - % kage.cgi 'u4e5f&type=eps' > result.eps
+
+2) Run as cgi program
+
+Call engine by a web browser like as `http://hoge.hoge/cgi-bin/kage.cgi?u4e00'.
 
 Glyph will be appear (`ICHI (one)' : u4e00 in ISO/IEC 10646-1).