aboutsummaryrefslogtreecommitdiff
path: root/docs/source/install.rst
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2018-03-13 22:24:22 +0100
committerKristian Evers <kristianevers@gmail.com>2018-03-13 22:28:09 +0100
commit263da4ad56beb6f9136e2a1fd4192b9aff594d31 (patch)
treef1cb47eb3055b99f93ad0a1697ec906dc9c5852e /docs/source/install.rst
parentf99a5f891a23db3744fedb547b600d18e716259c (diff)
downloadPROJ-263da4ad56beb6f9136e2a1fd4192b9aff594d31.tar.gz
PROJ-263da4ad56beb6f9136e2a1fd4192b9aff594d31.zip
Add install section to docs
Diffstat (limited to 'docs/source/install.rst')
-rw-r--r--docs/source/install.rst74
1 files changed, 74 insertions, 0 deletions
diff --git a/docs/source/install.rst b/docs/source/install.rst
new file mode 100644
index 00000000..6b244730
--- /dev/null
+++ b/docs/source/install.rst
@@ -0,0 +1,74 @@
+.. _install:
+
+================================================================================
+Installation
+================================================================================
+
+These pages describe how to install PROJ on your computer without compiling it
+yourself. Below are guides for installing on Windows, Linux and Mac OS X. This
+is a good place to get started if this is your first time using PROJ. More
+advanced users may want to compile the software themselves.
+
+Windows
+--------------------------------------------------------------------------------
+
+The simplest way to install PROJ on Windows is to use the `OSGeo4W`_ software
+distribution. OSGeo4W provides easy access to many popular open source geospatial
+software packages. After installation you can use PROJ from the OSGeo4W shell.
+To install PROJ do the following:
+
+.. note::
+ If you have already installed software via OSGeo4W on your computer it is
+ likely that PROJ is already installed.
+
+1. Download either the `32 bit`_ or `64 bit`_ installer.
+2. Run the OSGeo4W setup program.
+3. Select "Advanced Install" and press Next.
+4. Select "Install from Internet" and press Next.
+5. Select a installation directory. The default suggestion is fine in most cases. Press Next.
+6. Select "Local packacke directory". The suggestions is fine in most cases. Press Next.
+7. Select "Direct connection" and press Next.
+8. Choose the download.osgeo.org and press Next.
+9. Find "proj" under "Commandline_Utilities" and click the package in the "New" column until the version you want to install appears.
+10. Press next to install PROJ.
+
+You should now have a "OSGeo" menu in your start menu. Within that menu you can
+find the "OSGeo4W Shell" where you have access to all the OSGeo4W applications,
+including proj.
+
+For those who are more inclined to the command line, steps 2--10 above can be
+accomplished by executing the following command::
+
+ C:\temp\osgeo4w-setup-x86-64.exe -q -k -r -A -s http://download.osgeo.org/osgeo4w/ -a x86_64 -P proj
+
+.. _`OSGeo4W`: https://trac.osgeo.org/osgeo4w/
+.. _`32 bit`: http://download.osgeo.org/osgeo4w/osgeo4w-setup-x86.exe
+.. _`64 bit`: http://download.osgeo.org/osgeo4w/osgeo4w-setup-x86_64.exe
+
+Linux
+--------------------------------------------------------------------------------
+
+How to install PROJ on Linux depends on which distribution you are using. Below
+is a few examples for some of the more common Linux distributions:
+
+Debian
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+On Debian and similar systems (e.g. Ubuntu) the APT package manager is used::
+
+ sudo apt-get install proj
+
+Red Hat
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+On Red Hat based system packages are installed with yum::
+
+ sudo yum install proj
+
+
+Mac OS X
+--------------------------------------------------------------------------------
+
+On OS X PROJ can be installed via the Homebrew package manager:
+
+ brew install proj