1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Thu Jan 26 23:35:52 2012 +0000
     1.3 @@ -0,0 +1,68 @@
     1.4 +                                   gutcheck
     1.5 +                                   ========
     1.6 +
     1.7 +General installation instructions can be found in INSTALL. The following
     1.8 +aim to give a quick overview and some help for specific systems. Documentation
     1.9 +for gutcheck itself can be found in doc/gutcheck.txt and for the test
    1.10 +framework in doc/gc-test.txt.
    1.11 +
    1.12 +Linux
    1.13 +-----
    1.14 +
    1.15 +You should be able to use the standard:
    1.16 +
    1.17 +% ./configure
    1.18 +% make
    1.19 +% sudo make install
    1.20 +
    1.21 +If you get an error about no package 'glib-2.0' found, then you need to
    1.22 +install the development package for glib2. Under Fedora, RHEL and friends
    1.23 +that would be:
    1.24 +
    1.25 +% sudo yum install gcc pkgconfig glib2-devel
    1.26 +
    1.27 +Under Debian, Ubuntu and friends that would be:
    1.28 +
    1.29 +% sudo apt-get install gcc pkgconfig glib2-devel
    1.30 +
    1.31 +If you get really stuck, you can use the --without-glib option to configure,
    1.32 +but this may well not be supported in a future version so this is probably
    1.33 +best avoided.
    1.34 +
    1.35 +Microsoft Windows
    1.36 +-----------------
    1.37 +
    1.38 +It should be possible to use MSYS (http://www.mingw.org/wiki/MSYS) to build
    1.39 +on a Windows machine. You'll need a copy of the development package for
    1.40 +glib and its dependencies from http://www.gtk.org/download/win32.php.
    1.41 +
    1.42 +It's much easier to build using a cross-compiler from Linux, if you have
    1.43 +access to such a system. Under Fedora, RHEL and friends you can do this
    1.44 +with:
    1.45 +
    1.46 +% sudo yum install mingw32-gcc pkgconfig mingw32-glib2-static \
    1.47 +  mingw32-gettext-static mingw32-iconv-static
    1.48 +% ./configure --host=i686-w64-mingw32 --disable-shared \
    1.49 +  --bindir=/gutcheck --datadir=/
    1.50 +% make
    1.51 +% mkdir build
    1.52 +% make install DESTDIR=`pwd`/build
    1.53 +
    1.54 +The contents of the build/gutcheck directory can then be copied to a
    1.55 +Microsoft Windows machine.
    1.56 +
    1.57 +Depending on the version of mingw32-gcc you use, you may need to specify a
    1.58 +different host type. If you're not sure look and see what the cross-compiler
    1.59 +is called (eg., i686-pc-mingw32-gcc) and use the prefix as the host type.
    1.60 +
    1.61 +Mac
    1.62 +---
    1.63 +
    1.64 +I think this should be quite similar to Linux, doing something like this:
    1.65 +
    1.66 +% sudo port install gcc pkgconfig glib2-devel
    1.67 +% ./configure
    1.68 +% make
    1.69 +% sudo make install
    1.70 +
    1.71 +It may also be possible to use fink instead of macports.