aboutsummaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2018-05-10 17:34:36 +0200
committerKristian Evers <kristianevers@gmail.com>2018-05-12 12:22:19 +0200
commitf5eeef8a5933d41f229f6551c6612daa5d61a7b5 (patch)
tree303ce5443bf6325917cdc802703f11e42d8b9e59 /docs/source
parent5272565cdf5acfd15ab5c96a74f49d57b5a18217 (diff)
downloadPROJ-f5eeef8a5933d41f229f6551c6612daa5d61a7b5.tar.gz
PROJ-f5eeef8a5933d41f229f6551c6612daa5d61a7b5.zip
Add about section to docs
Short description of PROJ. Citation section added from README. License moved from it's own page to a section on the about page.
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/about.rst69
-rw-r--r--docs/source/index.rst2
-rw-r--r--docs/source/license.rst46
3 files changed, 70 insertions, 47 deletions
diff --git a/docs/source/about.rst b/docs/source/about.rst
new file mode 100644
index 00000000..198dbead
--- /dev/null
+++ b/docs/source/about.rst
@@ -0,0 +1,69 @@
+###############################################################################
+About
+###############################################################################
+
+PROJ is a generic coordinate transformation software, that transforms geospatial
+coordinates from one coordinate reference system (CRS) to another. This
+includes cartographic projections as well as geodetic transformations.
+
+PROJ includes :ref:`command line applications<apps>` for easy conversion of
+coordinates from text files or directly from user input. In addition to the
+command line utilities PROJ also exposes an
+:ref:`application programming interface<reference>`, or API in short. The API
+let developers use the functionality of PROJ in their own software without having
+to implement similar functionality themselves.
+
+PROJ started purely as a cartography application letting users convert geodetic
+coordinates into projected coordinates using a number of different cartographic
+projections. Over the years, as the need has become apparent, support for datum
+shifts has slowly worked it's way into PROJ as well. Today PROJ support more
+than a hundred different map projections and can transform coordinates between
+datums using all but the most obscure geodetic techniques.
+
+Citation
+-------------------------------------------------------------------------------
+
+To cite PROJ in publications use:
+
+ PROJ contributors (2018). PROJ coordinate transformation software
+ library. Open Source Geospatial Foundation. URL http://proj4.org/.
+
+A BibTeX entry for LaTeX users is
+
+.. code-block:: latex
+
+ @Manual{,
+ title = {{PROJ} coordinate transformation software library},
+ author = {{PROJ contributors}},
+ organization = {Open Source Geospatial Foundation},
+ year = {2018},
+ url = {http://proj4.org/},
+ }
+
+License
+-------------------------------------------------------------------------------
+
+PROJ uses the MIT license. The software was initially released by the USGS in
+the public domain. When Frank Warmerdam took over the development of PROJ it
+was moved under the MIT license. The license is as follows:
+
+ Copyright (c) 2000, Frank Warmerdam
+
+ Permission is hereby granted, free of charge, to any person obtaining a
+ copy of this software and associated documentation files (the "Software"),
+ to deal in the Software without restriction, including without limitation
+ the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ and/or sell copies of the Software, and to permit persons to whom the
+ Software is furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included
+ in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ DEALINGS IN THE SOFTWARE.
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
index ca14a5d6..97872470 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -7,6 +7,7 @@ PROJ
:maxdepth: 1
:hidden:
+ about
download
install
usage/index
@@ -18,7 +19,6 @@ PROJ
community/index
faq
glossary
- license
references
PROJ is a standard UNIX filter function which converts geographic longitude
diff --git a/docs/source/license.rst b/docs/source/license.rst
deleted file mode 100644
index bd4f633c..00000000
--- a/docs/source/license.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-.. _license:
-
-================================================================================
-License
-================================================================================
-
-:Author: Frank Warmerdam
-:Contact: warmerdam@pobox.com
-:Date: 2001
-
-PROJ.4 has been placed under an MIT license. I believe this to be as close as
-possible to public domain while satisfying those who say that a copyright
-notice is required in some countries. The COPYING file read as follows:
-
-All source, data files and other contents of the PROJ.4 package are available
-under the following terms. Note that the PROJ 4.3 and earlier was "public
-domain" as is common with US government work, but apparently this is not a well
-defined legal term in many countries. I am placing everything under the
-following MIT style license because I believe it is effectively the same as
-public domain, allowing anyone to use the code as they wish, including making
-proprietary derivatives.
-
-Though I have put my own name as copyright holder, I don't mean to imply I did
-the work. Essentially all work was done by Gerald Evenden.
-
-::
-
- Copyright (c) 2000, Frank Warmerdam
-
- Permission is hereby granted, free of charge, to any person obtaining a
- copy of this software and associated documentation files (the "Software"),
- to deal in the Software without restriction, including without limitation
- the rights to use, copy, modify, merge, publish, distribute, sublicense,
- and/or sell copies of the Software, and to permit persons to whom the
- Software is furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included
- in all copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
- DEALINGS IN THE SOFTWARE.