granicus.if.org Git - fortune-mod/blob - fortune-mod/INSTALL

   1 INSTALL file for fortune-mod
   2 ============================
   3 Shlomi Fish <shlomif@cpan.org>
   4 :Date: 2016-12-29
   5
   6 Quick and Dirty Compilation
   7 ---------------------------
   8
   9 fortune-mod uses CMake ( http://www.cmake.org/ )
  10 for its build system. Version 3 or later is required.
  11
  12 You will also need librecode (= the "recode" library) from
  13 https://github.com/rrthomas/Recode - version 3.7 or later.
  14
  15 Next, run:
  16
  17     mkdir build
  18     cd build
  19     cmake-gui ..         # For the GUI configuration applet
  20
  21 Or:
  22
  23     ccmake ..            # For the Curses-based configuration applet
  24
  25 With a fallback to:
  26
  27     cmake ..             # Non-interactive application.
  28
  29 This will build and install all the executables and install the fortune
  30 collections.
  31
  32 Installing under Win32
  33 ----------------------
  34
  35 Consult the CMake documentation for generating a Visual C++ , MinGW32
  36 etc. compatible makefile or project. It may only work under cygwin or similar
  37 environment.
  38
  39 Testing
  40 -------
  41
  42 The tests require the File::Find::Object Perl module
  43 (libfile-find-object-perl in Debian and derivatives), Test::Differences
  44 (libtest-differences-perl) and Test::RunValgrind (from CPAN).
  45
  46 To test fortune-mod, you need to:
  47
  48 1. Configure it.
  49
  50 2. Build it.
  51
  52 3. Run "make check".
  53
  54 Please report any errors to me ( http://www.shlomifish.org/me/contact-me/ ).