[geos-commits] r4199 - trunk

Sandro Santilli strk at keybit.net
Sat Apr 23 07:47:41 PDT 2016 

Author: strk
Date: 2016-04-23 07:47:41 -0700 (Sat, 23 Apr 2016)
New Revision: 4199

Removed:
   trunk/README
Modified:
   trunk/README.md
Log:
Merge README into README.md

Thanks Mike Toews for the kickstart on this

Deleted: trunk/README
===================================================================
--- trunk/README	2016-04-23 13:16:23 UTC (rev 4198)
+++ trunk/README	2016-04-23 14:47:41 UTC (rev 4199)
@@ -1,105 +0,0 @@
-BUILDING, TESTING, INSTALLING
-=============================
-
-Unix
-----
-
-Using Autotools:
-  ./autogen.sh  # in ${srcdir}, if obtained from SVN
-  ${srcdir}/configure # in build dir
-
-Using CMake:
-  cmake ${srcdir} # in build dir
-
-Now, all versions:
-  make
-  make check
-  make install # as root
-  ldconfig # as root
-
-Win32
------
-
-If you use Microsoft Visual C++ (7.1 or later) compiler, you can build 
-GEOS using NMAKE program and provided makefile.vc files.
-
-If you are building from SVN checkout, first run: autogen.bat
-Then:
-
-  nmake /f makefile.vc MSVC_VER=1400
-
-where 1400 is version number of Visual C++ compiler, here Visual C++ 8.0 
-from Visual Studio 2005 (supported versions are 1300, 1310, 1400 and 1500). 
-The bootstrap.bat step is required to generate a couple of header files.
-
-In order to build debug configuration of GEOS, additional flag DEBUG=1 
-is required:
-
-  nmake /f makefile.vc MSVC_VER=1400 DEBUG=1
-
-
-CLIENT APPLICATIONS
-===================
-
-Using the C interface (recommended)
------------------------------------
-
-To compile programs against the C lib (recommended):
-
-  CFLAGS += `geos-config --cflags`
-  LDFLAGS += `geos-config --ldflags` -lgeos_c
-  #include <geos_c.h>
-
-Example usage:
-
-  capi/geostest.c contains basic usage examples.
-
-Using the C++ interface (discouraged)
--------------------------------------
-
-NB: The C++ interface should not be used directly; the geos project
-views it as a bug for another program to use the C++ interface or even
-to directly link against the C++ library.  The C++ library name will
-change on every minor release because it is too hard to know if there
-have been ABI changes.  (The C libary uses the C++ interface, but the
-C library follows normal ABI-change-sensitive versioning, so programs
-that link only against the C library should work without relinking
-when geos is upgraded.)
-
-To compile programs against the C++ lib:
-
-  CFLAGS += `geos-config --cflags`
-  LDFLAGS += `geos-config --ldflags` -lgeos
-  #include <geos.h>
-
-Example usage:
-
-  doc/example.cpp contains basic usage examples.
-
-Scripting language bindings
----------------------------
-
-Ruby bindings are fully supported. To build, use the --enable-ruby option
-when configuring:
-
-  ./configure ... --enable-ruby
-
-PHP bindings are fully supported. To build, use the --enable-php option
-when configuring:
-
-  ./configure ... --enable-php
-    
-Since version 3.0, the Python bindings are unsupported. Recommended options:
-
- 1. Become or recruit a new maintainer.
- 2. Use Shapely (http://pypi.python.org/pypi/Shapely) with Python
-    versions 2.4 or greater.
- 3. Simply call functions from libgeos_c via Python ctypes.
-
-DOCUMENTATION
-=============
-
-  cd doc; make doxygen-html
-
-  http://trac.osgeo.org/geos
-

Modified: trunk/README.md
===================================================================
--- trunk/README.md	2016-04-23 13:16:23 UTC (rev 4198)
+++ trunk/README.md	2016-04-23 14:47:41 UTC (rev 4199)
@@ -1,5 +1,12 @@
+GEOS -- Geometry Engine, Open Source
+====================================
+
+Project homepage: http://geos.osgeo.org/
+
+## Build status
+
 Debbie:
- [![Build Status](http://debbie.postgis.net:8080/buildStatus/icon?job=GEOS_Trunk)]
+ [![Debbie](http://debbie.postgis.net:8080/buildStatus/icon?job=GEOS_Trunk)]
  (http://debbie.postgis.net:8080/view/GEOS/job/GEOS_Trunk/)
 Travis:
  [![Travis](https://secure.travis-ci.org/libgeos/libgeos.png)]
@@ -11,7 +18,104 @@
  [![drone.io](https://drone.io/github.com/libgeos/libgeos/status.png)]
  (https://drone.io/github.com/libgeos/libgeos/latest)
 
-This file is here to play nicely with modern code repositories.
-Actual readme is [here](README).
+## Building, testing, installing
 
-Project homepage: http://geos.osgeo.org/
+### Unix
+
+Using Autotools:
+
+    ./autogen.sh  # in ${srcdir}, if obtained from SVN or GIT
+    ${srcdir}/configure # in build dir
+
+Using CMake:
+
+    cmake ${srcdir} # in build dir
+
+Now, all versions:
+
+    make
+    make check
+    make install # as root
+    ldconfig # as root
+
+
+### Microsoft Windows
+
+If you use Microsoft Visual C++ (7.1 or later) compiler, you can build
+GEOS using NMAKE program and provided `makefile.vc` files.
+
+If you are building from SVN or GIT checkout, first run: `autogen.bat`
+Then:
+
+    nmake /f makefile.vc MSVC_VER=1400
+
+where 1400 is version number of Visual C++ compiler, here Visual C++ 8.0
+from Visual Studio 2005 (supported versions are 1300, 1310, 1400 and 1500).
+The bootstrap.bat step is required to generate a couple of header files.
+
+In order to build debug configuration of GEOS, additional flag `DEBUG=1`
+is required:
+
+    nmake /f makefile.vc MSVC_VER=1400 DEBUG=1
+
+
+## Client applications
+
+### Using the C interface (recommended)
+
+To compile programs against the C lib (recommended):
+
+    CFLAGS += `geos-config --cflags`
+    LDFLAGS += `geos-config --ldflags` -lgeos_c
+    #include <geos_c.h>
+
+Example usage:
+
+    capi/geostest.c contains basic usage examples.
+
+### Using the C++ interface (discouraged)
+
+NB: The C++ interface should not be used directly; the GEOS project
+views it as a bug for another program to use the C++ interface or even
+to directly link against the C++ library.  The C++ library name will
+change on every minor release because it is too hard to know if there
+have been ABI changes.  (The C library uses the C++ interface, but the
+C library follows normal ABI-change-sensitive versioning, so programs
+that link only against the C library should work without relinking
+when GEOS is upgraded.)
+
+To compile programs against the C++ lib:
+
+    CFLAGS += `geos-config --cflags`
+    LDFLAGS += `geos-config --ldflags` -lgeos
+    #include <geos.h>
+
+Basic usage examples can be found in `doc/example.cpp`.
+
+
+### Scripting language bindings
+
+Ruby bindings are fully supported. To build, use the `--enable-ruby` option
+when configuring:
+
+    ./configure ... --enable-ruby
+
+PHP bindings are fully supported. To build, use the `--enable-php` option
+when configuring:
+
+    ./configure ... --enable-php
+
+Since version 3.0, the Python bindings are unsupported. Recommended options:
+
+ 1. Become or recruit a new maintainer.
+ 2. Use [Shapely](http://pypi.python.org/pypi/Shapely) with Python
+    versions 2.4 or greater.
+ 3. Simply call functions from libgeos_c via Python ctypes.
+
+## Documentation
+
+To build Doxygen documentation:
+
+    cd doc
+    make doxygen-html
+

More information about the geos-commits mailing list