source/INSTALL

   1 Xestia Address Book Installation Instructions
   2 =============================================
   3
   4 This document explains how to install Xestia Address Book.
   5
   6 Requirements
   7 ============
   8
   9 (Minimum or later)
  10
  11 wxWidgets 3.0.0
  12 SFML 2.1
  13 libxml2 2.9.2
  14 iconv 1.14
  15 file 5.03
  16 curl 7.44
  17
  18 Configuration
  19 =============
  20
  21 After extracting from the archive, go into the source directory and type:
  22
  23 ./configure
  24
  25 Non-standard options available for configure are:
  26
  27 --enable-debug  Enable debugging features for the build.
  28
  29 Building
  30 ========
  31
  32 After running configure, to compile Xestia Address Book type:
  33
  34 make
  35
  36 For reference, on a early-2010 high-range laptop this should take around
  37 3-5 minutes to compile.
  38
  39 Install
  40 =======
  41
  42 After compiling has completed, to install type:
  43
  44 make install
  45
  46 This will copy the Xestia Address Book application to the requested
  47 installation directory.
  48
  49 Uninstall
  50 =========
  51
  52 To uninstall Xestia Address Book type:
  53
  54 make uninstall
  55
  56 This will remove the Xestia Address Book application from the requested
  57 installation directory.
  58
  59 Unit Testing
  60 ============
  61
  62 To unit test various functions used within Xestia Address Book go into the
  63 tests directory and type:
  64
  65 make
  66
  67 This will build the unit testing application for Xestia Address Book. To
  68 run the application after building type:
  69
  70 ./xestiaab_test
  71
  72 Follow the instructions in the application to unit test the functions used.