-*- mode: org -*-

Guile-FontConfig provides Guile Scheme bindings for the FontConfig C
shared library.  The bindings are written in pure Scheme by using
Guile's foreign function interface.

* Requirements

  Guile-FontConfig currently depends on the following packages:

  - GNU Guile >= 2.0.9
  - FontConfig
  - GNU Make
  - GNU pkg-config

  When building from a Git checkout, the following additional packages
  are required:

  - GNU Autoconf
  - GNU Automake
  - GNU Texinfo

* Installing

  Guile-FontConfig uses the standard GNU build system, so installation
  requires the usual incantations:

  #+BEGIN_SRC sh
    ./configure
    make
    make install
  #+END_SRC

  When building from a Git checkout, the following spell is necessary
  before running any of the above commands:

  #+BEGIN_SRC sh
    ./bootstrap
  #+END_SRC

  GNU Guix users may install the current development snapshot
  described in =guix.scm= with the following command:

  #+BEGIN_SRC sh
    guix package -f guix.scm
  #+END_SRC

* Developing

  To build the source code from a Git checkout, run the following:

  #+BEGIN_SRC sh
    ./bootstrap
    ./configure
    make
  #+END_SRC

  To start a Guile REPL with a pre-configured load path for using
  guile-fontconfig, use the =pre-inst-env= script:

  #+BEGIN_SRC sh
    ./pre-inst-env guile
  #+END_SRC

  GNU Guix users may create a development environment with all of the
  necessary dependencies by running the following command:

  #+BEGIN_SRC sh
    guix environment -l guix.scm
  #+END_SRC

* Contact & Credits

  Bug reports and patches may be sent to <nicolo@nixo.xyz>.

  This repository and this library is based on David Thomson's
  Guile-SDL2, available [[https://dthompson.us/projects/guile-sdl2.html][here]] and distributed under GNU LGPLv3+.