# $Id: README,v 1.2 2003/03/03 11:29:26 obraun Exp $
# $Unsane: projects/checkrdf/README,v 1.5 2005/05/29 19:27:39 lizard Exp $

This directory contains the sources for CheckRDF, a smart tool consisting of a
Shell script and a Haskell program for downloading RDF Site Summaries - and
showing news in a text file and in a HTML file. It is highly configurable.

See also <URL:http://checkrdf.sourceforge.net>

===============================================================================

INSTALLATION
============

You need HaXml-1.13 or higher <URL:http://www.cs.york.ac.uk/fp/HaXml/> and a
Haskell compiler, nhc98 <URL:http://www.cs.york.ac.uk/fp/nhc98/> or ghc
<URL:http://www.haskell.org/ghc/>.

To compile CheckRDF with ghc simply type

  make

To compile CheckRDF with ghc type

  make BUILD_WITH=NHC98

To install CheckRDF binaries, manpage, and examples under /usr/local type

  make install

If you want to use another prefix, simply use

  make PREFIX=/my/prefix install

===============================================================================

CONFIGURATION
=============

CheckRDF comes with the global configuration file checkrdf.rc. You can override
all variables in a file called ${HOME}/.checkrdf.rc and ${HOME}/.rdf/rc and in
a file you can pass with the -f option to the checkrdf script.

For more information about the configuration variables take a look at the
global configuration file.

For more information about the checkrdf options type

  checkrdf -h

===============================================================================

The CheckRDF License
====================

Acknowledgements
----------------

CheckRDF was developed by Oliver Braun with a lot of help from Michael Ebert,
Steffen Vogelreuter, and Dieter Rothacker.  Matthias Teege has submitted a lot
of useful bug reports and blog.news.css.

License
-------

Copyright (c) 2002-2005, Oliver Braun
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * The names of the authors may not be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

==============================================================================

Oliver Braun
Michael Ebert
Dieter Rothacker
Steffen Vogelreuter

Contact: checkrdf-cvs@lists.sourceforge.net
         or join #terraform on IRC (freenode.net)
