README

   1 ####################################################################
   2
   3      _             _       _______             _            _
   4     / /           / /     / _____/            / /          / /
   5    / /       _   / /__   / /____    _    _   / / _____    / /_
   6   / /       / / / __  \  \_____ \  / /  / / / / / __  \  / __ \
   7  / /_____  / / / /__/ /  _____/ / / /__/ / / / / /__/ / / /  \ \
   8 /_______/ /_/ /______/  /______/  \___  / /_/ / _____/ /_/   /_/
   9                                      / /     / /
  10                                     / /     / /
  11                                    /_/     /_/
  12
  13 ###################################################################
  14
  15   Table of Contents
  16
  17   1. Dependencies
  18     1.1 Supported Operating Systems
  19     1.2 Supported Compilers
  20     1.3 Additional Libraries
  21
  22   2. Build instructions
  23     2.1 Compiling the source code
  24     2.2 Installing
  25
  26   3. Acknowledgements
  27     3.1 Copyright and licensing
  28     3.2 Reporting bugs
  29
  30 ###########################################################
  31
  32   1. Dependencies
  33
  34     1.1 Supported Operating Systems
  35
  36        Currently, LibSylph can be run most Unix-systems, including, but not
  37        limited to, Linux, FreeBSD, Cygwin, Mac OS X, and a few others.
  38        In order for the binary relocation function to work (i.e.
  39        thisapp->getXXX() ), support for /proc/self/exe is required. On Mac OS X,
  40        the /proc filesystem is not enabled by default. However, OS X provides
  41        an alternate method for retrieving the full path to the running
  42        executable, therefore no extra software is needed to function correctly
  43        on Mac OS X.
  44
  45        Minimal support for Microsoft Windows is included as well. However, no
  46        compiler for this platform meets the required features (see 1.2), there-
  47        fore LibSylph WON'T run on Microsoft Windows currently.
  48
  49     1.2 Supported Compilers
  50
  51         As of now, only one specific compiler is supported: the GNU C++ compiler
  52         (g++), version 4.4.0 or later. LibSylph uses certain GNU C++
  53         specific extensions. Furthermore, support for certain C++0x constructs
  54         is required. At the day of writing this document, only the compiler
  55         mentioned above supports these extensions. In case you found another
  56         compiler to meet these requirements, please contact
  57         the LibSylph developers (see section 3.2)
  58
  59   2. Build Instructions
  60
  61     2.1 Compiling the source code
  62
  63         2.1.1 Dependancies
  64
  65             LibSylph depends on boehm-gc,icu, and gettext. You need to have
  66             these programs installed first. Please consult your operating
  67             system vendor's manuals or look at our wiki.
  68
  69        2.1.2 Building
  70
  71             To build the source code, issue the following commands:
  72
  73                  cmake .
  74                  make
  75
  76             Please note you might need to explicitely specify the path to
  77             a C++0x compiler by using -DCMAKE_CXX_COMPILER=/path/to/c++.
  78
  79     2.2 Installing
  80
  81         To install LibSylph, issue the following command as root (or your
  82         operating systems respective administrator account):
  83
  84               make install
  85
  86     2.3 Running the test suite
  87
  88         To run the test suite, issue the following command in the build
  89         directory:
  90
  91              make test
  92
  93         This will build and run the entire test suite.
  94
  95   3. Acknowledgements
  96
  97     3.1 Copyright and licensing
  98
  99         Please see the files `AUTHORS' and `COPYING' to see the names of the
 100         original authors and the license of the code, respectively.
 101
 102     3.2 Reporting bugs.
 103
 104         TODO Mailing list.
 105         We're poor devs, we don't have a mailing list. Just bother one of us
 106         with your questions (see `AUTHORS') and if we're in a good mood, we'll
 107         reply.
 108
 109 ###########################################################