[postgis-devel] [PostGIS] #1670: Update README.postgis (was: Update main README)

PostGIS trac at osgeo.org
Tue Mar 13 00:43:31 PDT 2012


#1670: Update README.postgis
---------------------------+------------------------------------------------
 Reporter:  mwtoews        |       Owner:  robe         
     Type:  task           |      Status:  new          
 Priority:  medium         |   Milestone:  PostGIS 2.0.0
Component:  documentation  |     Version:  trunk        
 Keywords:                 |  
---------------------------+------------------------------------------------

Comment(by mwtoews):

 As suggested, I've limited the scope of this ticket, but regardless, here
 is a summary of the changes:
  * Use consistent formatting in reStructuredText; see formatted result
 with `rst2pdf` or `rst2html`, or if you don't want to install docutils,
 you can copy/paste the text to http://www.tele3.cz/jbar/rest/rest.html
  * Wrap lines to 80 columns, trim trailing whitespace, replace tabs with
 space chars
  * Fix typos, and use consistent case and punctuation
  * Alphabetize the directory structure
  * Add `./libpgcommon` to directory structure, and attempt to describe it
  * Arrange style of REQUIREMENTS section a bit more consistent across
 components: removing repetition, stating what is required or optional,
 etc.
  * When referencing PostGIS SQL functions, use the "ST_" prefix, where
 applicable
  * Mention that both Raster and Topology extensions are built by default,
 add notes how build without them

 As for renaming to `README`, I did some digging and I was incorrect—it has
 always been named `README.postgis`. Renaming is off-scope.

 Both the whole `README.postgis` file and a diff patch are attached
 (replacing older files on this ticket).

-- 
Ticket URL: <http://trac.osgeo.org/postgis/ticket/1670#comment:3>
PostGIS <http://trac.osgeo.org/postgis/>
The PostGIS Trac is used for bug, enhancement & task tracking, a user and developer wiki, and a view into the subversion code repository of PostGIS project.


More information about the postgis-devel mailing list