Skip to content

Commit a91fab2

Browse files
committed
Reformat README to reStructuredText format, and fix spelling mistakes
1 parent e555a31 commit a91fab2

File tree

1 file changed

+31
-13
lines changed

1 file changed

+31
-13
lines changed

README.rst

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
# geospatial - PHP Geospatial Extension
1+
=====================================
2+
geospatial - PHP Geospatial Extension
3+
=====================================
24

3-
PHP Extension to handle common geospatial functions. The extension currently has implementations of the haversine and vincenty's formulas as well as a helmert transfomation function.
5+
PHP Extension to handle common geospatial functions. The extension currently
6+
has implementations of the Haversine and Vincenty's formulas as well as a
7+
Helmert transformation function.
48

5-
## Instalation
6-
----------------------------
9+
Instalation
10+
===========
11+
12+
::
713

814
git clone [email protected]:php-geospatial/geospatial.git
915
cd geospatial
@@ -12,23 +18,29 @@ PHP Extension to handle common geospatial functions. The extension currently has
1218
make
1319
sudo make install
1420

15-
Then add the extension to an ini file e.g. /etc/php.ini
21+
Then add the extension to an ini file e.g. /etc/php.ini::
1622

1723
extension = geospatial.so
1824

19-
## Usage
25+
Usage
26+
=====
2027

21-
The extension makes use of the geojson standard format for specying points as co-ordinates. One important thing to note about this format is that points are specied longitude **first** i.e. longitude, latitude.
28+
The extension makes use of the GeoJSON standard format for specifying points as
29+
co-ordinates. One important thing to note about this format is that points are
30+
specified longitude **first** i.e. longitude, latitude.
2231

23-
e.g.
32+
e.g.::
2433

2534
$greenwichObservatory = array(
2635
'type' => 'Point',
2736
'coordinates' => array( -0.001483 , 51.477917);
2837
);
2938

3039

31-
### Haversine
40+
Haversine
41+
---------
42+
43+
::
3244

3345
$from = array(
3446
'type' => 'Point',
@@ -41,9 +53,12 @@ e.g.
4153
var_dump(haversine($to, $from));
4254
4355

44-
### Vincenty's Formula
56+
Vincenty's Formula
57+
------------------
4558

46-
Vincenty's formula attempts to provide a more acurate distance between two points than the Haversine formula. Whereas the Haversine formula assumes a spherical earth the Vincenty method models the earth as an ellipsoid.
59+
Vincenty's formula attempts to provide a more accurate distance between two
60+
points than the Haversine formula. Whereas the Haversine formula assumes a
61+
spherical earth the Vincenty method models the earth as an ellipsoid::
4762

4863
$flinders = array(
4964
'type' => 'Point',
@@ -56,9 +71,12 @@ Vincenty's formula attempts to provide a more acurate distance between two point
5671
var_dump(vincenty($flinders, $buninyong));
5772

5873

59-
### Helmert Transformation
74+
Helmert Transformation
75+
----------------------
6076

61-
The Helmert transformation allows for the transfomation of points between different datums. It can for instance be used to convert between the WGS84 ellipsoid used by GPS systems and OSGB36 used by ordnance survey in the UK.
77+
The Helmert transformation allows for the transformation of points between
78+
different datums. It can for instance be used to convert between the WGS84
79+
ellipsoid used by GPS systems and OSGB36 used by ordnance survey in the UK::
6280

6381
$greenwichObservatory = array(
6482
'type' => 'Point',

0 commit comments

Comments
 (0)