
                     README - info file

Copyright (C) 2005,2008,2010 Free Software Foundation, Inc.

Written by Maurizio Boriani <baux@member.fsf.org> 
and Linas Vepstas <linasvepstas@gmail.org>

* About

 guile-dbi provides a simple, generic, easy-to-use scheme/guile interface
 to SQL databases, such as Postgres or MySQL.

 The system is split into two parts: the DBI (database independent) part,
 which provides the scheme interfaces, and the DBD (database dependent)
 plugins, which connect to the actual SQL server. Currently, there are
 DBD backends for PostgreSQL, MySQL and SQLite3.

 Please send patches and bug reports to guile-user@gnu.org, and be sure
 to copy Linas Vepstas <linasvepstas@gmail.com>. Alternately, they may
 be posted at bug reports to https://gna.org/bugs/?group=guile-dbi, in
 which case the mailing list should be notified anyway.

* Guile DBI dependencies

   guile dbi depends from this packages, need them to build and run:
	
	Guile: http://www.gnu.org/software/guile/  
		The guile scheme implementation

   Be sure to install both the runtime and the development environment;
   devel is needed to compile guile-dbi.

   Optionally(?)
	Greg:  http://www.gnu.org/software/greg/
		A great test framework.

   A working compiler and build toolchain, etc.

* Compiling

   The standard build tools should work:
   ./configure
   make
   make install

   Be sure to also do the above steps for the guile-dbd backends
   you wish to run!

* Testing

  make check

  Requires the greg testing framework, available at 
  http://home.gna.org/greg/

* Guile DBI Documentation

   The doc directory contains the reference manual  and some examples.

   The www pages are at http://www.gnu.org/software/guile-dbi or
   https://htmlpreview.github.io/?https://github.com/opencog/guile-dbi/blob/master/website/index.html

   The project page is at: https://github.com/opencog/guile-dbi

* Verifying

   The system is distributed using the normal tar.gz format; it can be
   extracted using the "tar -zxf guile-dbi-2.1.6.tar.gz" command at the
   command line.

   The files have been digitally signed to make sure that there was no
   corruption of the dataset during download, and to help ensure that
   no malicious changes were made to the code internals by third
   parties. The signatures can be checked with the gpg command:

   gpg --verify guile-dbi-2.1.6.tar.gz.asc

   which should generate output identical to (except for the date):

   gpg: Signature made Tue Feb 26 19:41:07 2008 CST using RSA key ID C0389241
   gpg: Good signature from "Linas Vepstas (current active email; others are inactive) <linasvepstas@gmail.com>"

* Guile DBI License

 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, 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.

 You should have received a copy of the GNU General Public License
 along with this software; see the file COPYING.  If not, write to
 the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 Boston, MA 02111-1307 USA
