README

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