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

   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.2 or later is required.
  11
  12 You will also need:
  13
  14 1. librecode (= the "recode" library) from https://github.com/rrthomas/Recode - version 3.7 or later.
  15
  16 2. rinutils from https://github.com/shlomif/rinutils (should be bundled with
  17 fortune-mod's source.
  18
  19 3. cmocka from https://cmocka.org/ (for testing only).
  20
  21 Next, run:
  22
  23     mkdir build
  24     cd build
  25     cmake-gui ..         # For the GUI configuration applet
  26
  27 Or:
  28
  29     ccmake ..            # For the Curses-based configuration applet
  30
  31 With a fallback to:
  32
  33     cmake ..             # Non-interactive application.
  34
  35 This will build and install all the executables and install the fortune
  36 collections.
  37
  38 Installing under Win32
  39 ----------------------
  40
  41 Consult the CMake documentation for generating a Visual C++ , MinGW32
  42 etc. compatible makefile or project. It may only work under cygwin or similar
  43 environment.
  44
  45 Testing
  46 -------
  47
  48 The tests require the File::Find::Object Perl module
  49 (libfile-find-object-perl in Debian and derivatives), Test::Differences
  50 (libtest-differences-perl),
  51 Path::Tiny ( libpath-tiny-perl ), and Test::RunValgrind (from CPAN).
  52
  53 To test fortune-mod, you need to:
  54
  55 1. Configure it.
  56
  57 2. Build it.
  58
  59 3. Run "make check".
  60
  61 Please report any errors to me ( http://www.shlomifish.org/me/contact-me/ ).