From: Kevin Neufeld <kneufeld.ca@gmail.com>
Date: Fri, 3 Jul 2009 04:56:08 +0000 (+0000)
Subject: updated the doc's README file
X-Git-Tag: 1.5.0b1~601
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=56e601d4264880ecd03f8e15d7907a46322e624c;p=postgis

updated the doc's README file
made "images" a target to "all" so the images get automatically generated when calling make with no parameters.

git-svn-id: http://svn.osgeo.org/postgis/trunk@4253 b70326c6-7e19-0410-871a-916f4a2858ee
---

diff --git a/doc/Makefile.in b/doc/Makefile.in
index cda301410..ca6cac6e1 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -56,7 +56,7 @@ else
 ifeq ($(IMAGEMAGICK),)
 all: requirements_not_met_imagemagick
 else
-all: html/postgis.html postgis_comments.sql
+all: images html/postgis.html postgis_comments.sql
 endif
 endif
 endif
diff --git a/doc/README b/doc/README
index 1d9d881fb..3f2f8f323 100644
--- a/doc/README
+++ b/doc/README
@@ -1,36 +1,50 @@
+====================================================
 Overview
-========
-
-Postgis documentation is written in docbook xml.
-Input file is postgis.xml. From that file we can
-convert to chunked html, single file html and pdf.
+====================================================
 
-Rules are:
+Postgis documentation is written in docbook xml.  The input file is postgis.xml, 
+which in turn includes all the individual chapter xml files.  From that file we 
+can convert to chunked html, single-file html and pdf.
+
+Make targets are:
+
+  make                      # defaults to creating  
+                            #   - the images used in the generated documentation
+                            #   - the documentation as a single html file
+                            #   - a sql script used to apply COMMENTS for every postgis function
+  
+  make html/postgis.html    # generates a single-file html file called html/postgis.html
+  make chunked-html         # generates a separate html file for every chapter or section break
+  make pdf                  # generates a single pdf file with the postgis version as a filename
+  make images               # generates all the images used in the html and pdf targets
+  make comments             # generates a sql script that add COMMENTs for every function (derived from the documentation)
+  make doxygen              # generates the developer's documentation using Doxygen
+  
+  make install              # copies PostGIS' utility (ie. shp2pgsql) man pages to the PostgreSQL's doc directory
+  make uninstall            # removes PostGIS' utility man pages
+  make comments-install     # copies the postgis-comments.sql script to the PostgreSQL's contrib directory
+  make comments-uninstall   # removes the postgis-comments.sql script from the contrib directory
+  
+  make clean                # removes any generated files (except images and html files)
+  make maintainer-clean     # clears out the generated images and html files
 
-	make html # output in html/postgis.html
-	make chunked-html
-	make postgis.pdf
 
 ====================================================
- WARNING
+Requirements
 ====================================================
 
-Informations passed this point are out-of-date.
-We're moving toward only requiring 'docbook-utils'
-package.
+To generate the html files:
+  xsltproc                  (http://xmlsoft.org/XSLT/xsltproc2.html)
+  DocBook XSL scripts
 
-====================================================
+To generate the images:
+  ImageMagick               (http://www.imagemagick.org/script/index.php)
 
-Common requirements
-===================
+To generate a pdf:
+  dblatex                   (http://dblatex.sourceforge.net)
 
-debian packages:
-	- xlstproc 
+To generate the developer's documentation:
+  doxygen                   (http://www.stack.nl/~dimitri/doxygen)
 
-Requirements to build postgis.pdf
-=================================
 
-debian packages:
-	- passivetex 
-	- xmltex  (for pdfxmltex)