Completed Getting started
This commit is contained in:
parent
6084d3fcb9
commit
ea82b5474e
37
docs/getting_started.rst
Normal file
37
docs/getting_started.rst
Normal file
|
@ -0,0 +1,37 @@
|
|||
Getting Started
|
||||
===============
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
In order to compile ``liboceanography`` you need:
|
||||
* a C compiler;
|
||||
* `cmake <http://www.cmake.org/>`_ 2.8 or greater.
|
||||
|
||||
For compiling unit tests you also need `Check unit test framework for C
|
||||
<http://check.sourceforge.net/>`_.
|
||||
|
||||
Download
|
||||
--------
|
||||
|
||||
You can download a packaged version of ``liboceanography``
|
||||
from http://downloads.mornie.org/liboceanography
|
||||
|
||||
Installing liboceanography
|
||||
--------------------------
|
||||
|
||||
``liboceanography`` has a cmake based configuration system that handles
|
||||
build, test and installation.
|
||||
|
||||
The following instructions are for **unix** type systems.
|
||||
|
||||
Once downloaded the tarball you have to do::
|
||||
|
||||
$ tar xzf liboceanography-1.0.0.tar.gz
|
||||
$ cd liboceanography-1.0.0/
|
||||
$ mkdir build
|
||||
$ cmake ..
|
||||
$ make
|
||||
$ make test
|
||||
$ make install
|
||||
|
Loading…
Reference in a new issue