INSTALL file for fortune-mod
============================
Shlomi Fish <shlomif@cpan.org>
:Date: 2016-12-29

Quick and Dirty Compilation
---------------------------

fortune-mod uses CMake ( http://www.cmake.org/ )
for its build system. Version 3.2 or later is required.

You will also need:

1. librecode (= the "recode" library) from https://github.com/rrthomas/Recode - version 3.7 or later.

2. rinutils from https://github.com/shlomif/rinutils (should be bundled with
fortune-mod's source.

3. cmocka from https://cmocka.org/ (for testing only).

Next, run:

    mkdir build
    cd build
    cmake-gui ..         # For the GUI configuration applet

Or:

    ccmake ..            # For the Curses-based configuration applet

With a fallback to:

    cmake ..             # Non-interactive application.

This will build and install all the executables and install the fortune
collections.

Installing under Win32
----------------------

Consult the CMake documentation for generating a Visual C++ , MinGW32
etc. compatible makefile or project. It may only work under cygwin or similar
environment.

Testing
-------

The tests require the File::Find::Object Perl module
(libfile-find-object-perl in Debian and derivatives), Test::Differences
(libtest-differences-perl),
Path::Tiny ( libpath-tiny-perl ), and Test::RunValgrind (from CPAN).

To test fortune-mod, you need to:

1. Configure it.

2. Build it.

3. Run "make check".

Please report any errors to me ( http://www.shlomifish.org/me/contact-me/ ).