README
author ali <ali@juiblex.co.uk>
Wed Jan 25 19:33:43 2012 +0000 (2012-01-25)
changeset 2 cbd63f7ba40f
child 5 f600b0d1fc5d
permissions -rw-r--r--
Don't test that gutcheck ignores paragraphs with only short lines
ali@0
     1
                                   gutcheck
ali@0
     2
                                   ========
ali@0
     3
ali@0
     4
General installation instructions can be found in INSTALL. The following
ali@0
     5
aim to give a quick overview and some help for specific systems. Documentation
ali@0
     6
for gutcheck itself can be found in doc/gutcheck.txt and for the test
ali@0
     7
framework in doc/gc-test.txt.
ali@0
     8
ali@0
     9
Linux
ali@0
    10
-----
ali@0
    11
ali@0
    12
You should be able to use the standard:
ali@0
    13
ali@0
    14
% ./configure
ali@0
    15
% make
ali@0
    16
% sudo make install
ali@0
    17
ali@0
    18
If you get an error about no package 'glib-2.0' found, then you need to
ali@0
    19
install the development package for glib2. Under Fedora, RHEL and friends
ali@0
    20
that would be:
ali@0
    21
ali@0
    22
% sudo yum install gcc pkgconfig glib2-devel
ali@0
    23
ali@0
    24
Under Debian, Ubuntu and friends that would be:
ali@0
    25
ali@0
    26
% sudo apt-get install gcc pkgconfig glib2-devel
ali@0
    27
ali@0
    28
If you get really stuck, you can use the --without-glib option to configure,
ali@0
    29
but this may well not be supported in a future version so this is probably
ali@0
    30
best avoided.
ali@0
    31
ali@0
    32
Microsoft Windows
ali@0
    33
-----------------
ali@0
    34
ali@0
    35
It should be possible to use MSYS (http://www.mingw.org/wiki/MSYS) to build
ali@0
    36
on a Windows machine. You'll need a copy of the development package for
ali@0
    37
glib and its dependencies from http://www.gtk.org/download/win32.php.
ali@0
    38
ali@0
    39
It's much easier to build using a cross-compiler from Linux, if you have
ali@0
    40
access to such a system. Under Fedora, RHEL and friends you can do this
ali@0
    41
with:
ali@0
    42
ali@0
    43
% sudo yum install mingw32-gcc pkgconfig mingw32-glib2-static \
ali@0
    44
  mingw32-gettext-static mingw32-iconv-static
ali@0
    45
% ./configure --host=i686-w64-mingw32 --disable-shared \
ali@0
    46
  --bindir=/gutcheck --datadir=/
ali@0
    47
% make
ali@0
    48
% mkdir build
ali@0
    49
% make install DESTDIR=`pwd`/build
ali@0
    50
ali@0
    51
The contents of the build/gutcheck directory can then be copied to a
ali@0
    52
Microsoft Windows machine.
ali@0
    53
ali@0
    54
Depending on the version of mingw32-gcc you use, you may need to specify a
ali@0
    55
different host type. If you're not sure look and see what the cross-compiler
ali@0
    56
is called (eg., i686-pc-mingw32-gcc) and use the prefix as the host type.
ali@0
    57
ali@0
    58
Mac
ali@0
    59
---
ali@0
    60
ali@0
    61
I think this should be quite similar to Linux, doing something like this:
ali@0
    62
ali@0
    63
% sudo port install gcc pkgconfig glib2-devel
ali@0
    64
% ./configure
ali@0
    65
% make
ali@0
    66
% sudo make install
ali@0
    67
ali@0
    68
It may also be possible to use fink instead of macports.