bump up version number
[mancala] / INSTALL
1 /*  
2  *  Mancala Installation Instructions
3  *  $Id: INSTALL,v 1.1.2.1 2004/01/17 20:09:02 sparrow_hawk Exp $
4  *
5  *  Copyright (C) 2003 Kevin Riggle
6  *  <sparrow_hawk@users.sourceforge.net>
7  *  http://cmancala.sourcefoge.net
8  *
9  *  This program is free software; you can redistribute it and/or modify it
10  *  under the terms of the GNU General Public License as published by the
11  *  Free Software Foundation; either version 2, or (at your option) any
12  *  later version.
13  *
14  *  This program is distributed in the hope that it will be useful, but
15  *  WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  *  General Public License for more details, a copy of which may be found in
18  *  the file COPYING provided in the main directory of this release.
19  *
20  */
21
22 To compile mancala, you will need:
23 - the Simple DirectMedia Layer (SDL), the main graphics library
24   (http://www.libsdl.org)
25 - SDL_image (http://www.libsdl.org/projects/SDL_image/)
26 - SDL_ttf (http://www.libsdl.org/projects/SDL_ttf/)
27 - the Bitstream Vera fonts (http://www.gnome.org/fonts/)
28
29 SDL_image in turn requires:
30 - libPNG (http://www.libpng.org/pub/png/libpng.html)
31 - zlib (http://www.gzip.org/zlib/)
32
33 SDL_ttf needs:
34 - FreeType2 (http://www.freetype.org/)
35 If you're a CVS junkie, note that the SDL_ttf in question is the SDL_ttf2
36 module, not the SDL_ttf one.  It'll save you a lot of time and hassle.
37
38 This seems like a lot because it is.  Most modern distributions have libSDL and
39 the support libraries (eg. libPNG), so all you will need to compile are 
40 SDL_image and SDL_ttf.  Check your system before compiling anything from source
41 (eg. rpm -q libSDL).
42
43 To compile mancala itself, unzip the source tarball and cd to the 'src' 
44 directory under the 'mancala-gui-0.x.x' directory.  From there, type 'make', 
45 su to root, and type 'make install'.  Congratulations!  You've just installed
46 mancala!
47
48 If the Bitstream Vera fonts are *not* in /usr/share/fonts/bitstream-vera, make
49 the appropriate change to main.h before compiling.  My guess is that anyone on
50 RedHat >=8.0 or Fedora will have no problem compiling this.  Those on other
51 distributions may have more problems.
52
53 Mancala is, at this point, only distributed as source.  I intend to make binary 
54 packages available eventually, but that is going to take some doing, and I feel
55 it is more important to release *something* than to wait until it is perfect.
56 This program doesn't have much more than a niche following anyway, so if you
57 want to run it I assume you can compile it yourself.  I have not been able to
58 make it compile on Windows (using mingw), so if anyone else has better luck I
59 would be very interested to hear about it.
60
61 Thanks for trying mancala out, and feel free to e-mail me at 
62 sparrow_hawk@users.sourceforge.net if you have any questions.