# -----------------------------------------------------------------------------
# libdf3  v 0.2.1
# -----------------------------------------------------------------------------

libdf3 is a tiny 'C' library which provides an API to access density pattern
files, as documented in the Persistence Of Vision Raytracing 3.7.x manual.

libdf3 is part of my 'df3 tools' project.  this is the first maintenance
release which sees one of the todo items ticked off (data pointer value now
included in checksum calculation), and the addition of an attribute to two
of the API function prototypes: both df3_open_file and df3_create_file now
have an "__attribute__((warn_unused_result))" to highlight lack of return
value checking.

building the library:
    $ tar xf df3-0.2.1.tar.gz
    $ cd df3-0.2.1
    $ ./configure
    $ make
    $ # installing requires privileges, change to 'root'.
    # make install
    # # the run time linker cache (probably) needs refreshing.
    # ldconfig

the libdf3 man page is created from a .pod file.  this requires the
'pod2man(1)' program, so a pre-built page is included in the package,
just in case.

the library does not have any dependencies (apart from the 'C' library),
and was developed using GNU compilers and autotools software.

libdf3 is released under a GNU Public License v3 or later, see the COPYING
file for details.

the library has been tested on both the 32-bit and 64-bit versions of a
GNU/Linux distribution, on a 64-bit machine.  however, I have not been able
to build or test on a 32-bit OS running on a 32-bit machine (haven't the
hardware); expect problems if type (off_t) is not eight bytes wide,
and or FILE_OFFSET_BITS != 64.

note - this is a hobbyist project by a (pretty poor) hobbyist programmer,
so all hints, tips, and or constructive criticisms helping to improve the
library will be welcomed.  please add "libdf3" in the subject line.

contact: jr <creature.eternal@gmail.com>.

enjoy.


ps - if you find this software useful and you're not on the breadline,
please make a donation to one of the good causes below.  thank you.

    - Médecins Sans Frontières, http://www.msf.org/

    - Free Software Foundation, https://fsf.org/

    - Royal National Lifeboat Institution, https://rnli.org/

    - a registered charity of your choice.

