guile-squee/doc/introduction.texi

@c -*- mode: texinfo; coding: utf-8 -*-
@c This is part of the Guile-Squee User Manual.
@c Copyright (C) 2015
@c David Pirotte <david at altosw dot be>
@c See the file squee.texi for copying conditions.


@node Introduction
@chapter Introduction

@menu
* About Guile-Squee::                
* Guile-Squee the name::
* What else::
* Obtaining and Installing Guile-Squee::
* Reporting Bugs::
@end menu


@c @unnumberedsec About Guile-Squee
@node About Guile-Squee
@section About Guile-Squee


Guile-Squee is a PostgreSQL binding for the @uref{@value{UGUILE}, Guile} Scheme language.


@node Guile-Squee the name
@section Guile-Squee the name

Guile-Squee! Why "squee"? Because "squeal" is a silly way to pronounce
SQL, and "squee" is an always-happy squeal! (Thanks for the great name,
Aeva and Sheila!)


@node What else
@section What else

Guile-Squee is written in ...

@node Obtaining and Installing Guile-Squee
@section Obtaining and Installing Guile-Squee

Guile-Squee can be obtained from the following archive site
@uref{@value{UGUILE-SQUEE-RELEASES}}.  The file will be named
guile-squee-version.tar.gz. The current version is @value{VERSION}, so the
file you should grab is:

@tie{}@tie{}@tie{}@tie{}@uref{@value{UGUILE-SQUEE-LATEST}}

@menu
* Dependencies::
* Quickstart::
@end menu

@node Dependencies
@subsection Dependencies

Guile-Squee needs the following software to run:

@itemize @bullet
@item
@uref{@value{UGUILE}, guile}>= 2.0.11
@item
lpbpq5 >= 9.4
@end itemize

@node Quickstart
@subsection Quickstart

Assuming you have satisfied the dependencies, open a terminal and
proceed with the following steps:

@example
cd <download-path>
tar zxf guile-squee-@value{VERSION}.tar.gz
cd guile-squee-@value{VERSION}
./configure [--prefix=/your/prefix]
make
make install
@end example

To use guile-squee <fixme>.

@strong{Notes:}

@enumerate
@item
In the above @code{configure} step, @code{--prefix=/your/prefix} is
optional.  The default value is @code{/usr/local}.

@item
To install Guile-Squee you must have @code{write permissions} for (a)
@code{$prefix} and its subdirs, (b) guile's @code{global-site-dir} and
(c) guile's @code{site-ccache} dir [see below].

@item
Guile-Squee's modules are installed in the guile's @code{global-site-dir},
Guile-Squee's compiled modules are installed in the Guile's
@code{site-ccache}. If you'd like to know where that is, enter the
following expressions in a terminal:

@example
guile -c "(display (%global-site-dir)) (newline)"
guile -c "(display (%site-ccache-dir)) (newline)"
@end example

@item
Like for any other GNU Tool Chain compatible software, you may install
the documentation locally using @code{make install-html} [or @code{make
install-pdf} ...].

@end enumerate

Happy Guile-Squee!


@node Reporting Bugs
@section Reporting Bugs

Please send your questions, bug reports and/or requests for improvements
to @email{guile-user at gnu dor org}.