.=title:	README
.?author:	Makoto Kuwata <kwa(at)kuwata-lab.com>
.?lastupdate:	$Date: 2004/04/23 06:42:39 $



.$ About Kwartz

  Kwartz is a template system implemented in Ruby.
  It has following features:

   .* Separate presentation logic from presentation data.
   .* Very fast
   .* Multi programing language (Ruby, PHP, Java)
   .* Doesn't break HTML design at all
   .* Can handle any text file
   .* Auto-Sanitizing Supported

  See user's guide for more detail.



.$ Installation

  Kwartz is implemented in Ruby.
  You have to install Ruby (1.6.8/1.8.1 or later) to use Kwartz.

  There are two ways to install Kwartz.

  .% If you can be root user:
	Install according to the following step:
	.====================
	$ ruby setup.rb config
	$ ruby setup.rb setup
	$ sudo
	# ruby setup.rb install
	.====================

  .% If you cannot be root user:
	Install according to the following step:
	.====================
	### Put 'bin/kwartz' and 'bin/mkmethod' to a suitable directory.
	$ cp bin/kwartz bin/mkmethod $HOME/bin
	
	### Put library file 'lib/kwartz.rb' to a suitable directory.
	$ mkdir $HOME/lib/ruby
	$ cp lib/kwartz.rb $HOME/lib/ruby
	
	### Set environment variable $RUBYLIB.
	$ export RUBYLIB=$HOME/lib/ruby
	.====================



.$ Manifest

  .% README.en.txt, README.ja.txt
	Readme file (in English/Japanese).
	
  .% bin/kwartz
	Command file
	
  .% bin/mkmethod
	A utility script to compile template and generate method or
	module of Ruby.
	
  .% lib/kwartz.rb
	Kwartz library file.
	
  .% ChangeLog.en.html, ChangeLog.ja.html
	Change log (in English/Japanese).
	
  .% users-guide/
	Kwartz user's guide (in English/Japanese)
	
  .% test/
	UnitTest (cd test; ruby test.rb; ruby test.cmp.rb)
	
  .% doc/
	Document, generated by RDoc
	
  .% util/validator.{php,cgi}
	PHP/CGI script which delete kd attributes from a HTML file
	and pass it to W3C Markup Validation Service.
	


.$ Announcement

  .* This project is subsidized by Exploratory Software Project of IPA
     (Information-Technology Promotion Agency Japan).
     See http://www.ipa.go.jp/about/english/index.html for IPA.

  .* If you have any questions or reports, send a e-mail to 
     <kwa(at)kuwata-lab.com> with a title starting with '[Kwartz]'.

  .* GPL is applied to Kwartz Software, but not applied to files
     which are genereated by Kwartz.



.$ License

  Copyright (C) 2004 kuwata-lab
  All rights reserved.
  
  This software is under GNU GPL.
  
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
  
  This program 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 General Public License for more details..	

.#@EOF
