README

   1 BUILDING, TESTING, INSTALLING
   2 =============================
   3
   4 Unix
   5 -----
   6
   7         # ./configure
   8         # make
   9         # make check
  10         # make install
  11
  12 Win32
  13 -----
  14
  15 If you use Microsoft Visual C++ (7.1 or later) compiler, you can build
  16 GEOS using NMAKE program and provided makefile.vc files.
  17
  18 If you are building from SVN checkout, first run: autogen.bat
  19 Then:
  20
  21   nmake /f makefile.vc MSVC_VER=1400
  22
  23 where 1400 is version number of Visual C++ compiler, here Visual C++ 8.0
  24 from Visual Studio 2005 (supported versions are 1300, 1310, 1400 and 1500).
  25 The bootstrap.bat step is required to generate a couple of header files.
  26
  27 In order to build debug configuration of GEOS, additional flag DEBUG=1
  28 is required:
  29
  30   nmake /f makefile.vc MSVC_VER=1400 DEBUG=1
  31
  32
  33 CLIENT APPLICATIONS
  34 ===================
  35
  36 Using the C interface (recommended)
  37 -----------------------------------
  38
  39 To compile programs against the C lib (recommended):
  40
  41         CFLAGS += `geos-config --cflags`
  42         LDFLAGS += `geos-config --ldflags` -lgeos_c
  43         #include <geos_c.h>
  44
  45 Example usage:
  46
  47         capi/geostest.c contains basic usage
  48         examples.
  49
  50 Using the C++ interface (discouraged)
  51 -------------------------------------
  52
  53 To compile programs against the C++ lib:
  54
  55         CFLAGS += `geos-config --cflags`
  56         LDFLAGS += `geos-config --ldflags` -lgeos
  57         #include <geos.h>
  58
  59 Example usage:
  60
  61         doc/example.cpp contains basic usage
  62         examples.
  63
  64 Scripting language bindings
  65 ---------------------------
  66
  67 Ruby bindings are fully supported. To build, use the --enable-ruby option when
  68 configuring:
  69
  70     # ./configure ... --enable-ruby
  71
  72 Since version 3.0, the Python bindings are unsupported. Recommended options:
  73
  74  1. Become or recruit a new maintainer.
  75  2. Use Shapely (http://pypi.python.org/pypi/Shapely) with Python versions 2.4 or greater.
  76  3. Simply call functions from libgeos_c via Python ctypes.
  77
  78 DOCUMENTATION
  79 =============
  80
  81         # cd doc; make doxygen-html
  82
  83         http://trac.osgeo.org/geos
  84