Skip to content

Commit 156fcc4

Browse files
author
Markus Nullmeier
committed
Update README.pg_sphere and documentation
1 parent 2b2a2ef commit 156fcc4

File tree

3 files changed

+21
-18
lines changed

3 files changed

+21
-18
lines changed

README.pg_sphere

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
1-
This is R-Tree implementation using GiST for spherical objects
1+
This is an R-Tree implementation using GiST for spherical objects
22
like spherical points and spherical circles with
33
useful functions and operators.
44

55

66
NOTICE:
7-
This version will works only with postgresql version 8.0 and above.
7+
This version will work only with postgresql version 9.1 and above.
88

99
INSTALLATION:
1010

11-
gmake
12-
gmake install
13-
-- load functions
14-
psql <database> < pg_sphere.sql
11+
make USE_PGXS=1
12+
make USE_PGXS=1 install
13+
-- add the psSphere extension to a database
14+
psql -c 'CREATE EXTENSION pg_sphere;' <database>
1515

16-
REGRESSION TEST:
16+
REGRESSION TEST (as the same user as the currently running postgresql server):
1717

18-
gmake installcheck
18+
make USE_PGXS=1 installcheck
1919

2020
LONG REGRESSION TEST:
2121

22-
gmake crushtest
22+
make USE_PGXS=1 crushtest
2323

24-
For more informations have a look at http://pgsphere.projects.postgresql.org/
24+
The 'make' program must be compatible with GNU make.
25+
26+
For more information, have a look at http://pgsphere.projects.postgresql.org
27+
and https://github.com/akorotkov/pgsphere
2528

2629
Have a lot of fun!
2730

doc/indices.sgm

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@
1010
<application>pgSphere</application> uses <literal>GiST</literal>
1111
to create spherical indices. An index speeds up the execution
1212
time of operators <link
13+
linkend="op.over"><literal>&lt;@</literal></link>, <link
1314
linkend="op.over"><literal>@</literal></link>, <link
1415
linkend="op.over"><literal>&amp;&amp;</literal></link>, <link
1516
linkend="op.cross"><literal>&num;</literal></link>, <link
1617
linkend="op.equal"><literal>=</literal></link>, and <link
1718
linkend="op.equal"><literal>!=</literal></link>. You can create
18-
an index with following spherical data types:
19+
an index with the following spherical data types:
1920
</para>
2021
<itemizedlist>
2122
<listitem>

doc/install.sgm

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<para>
1010
<application>pgSphere</application> is not part of the <application>PostgreSQL</application> software.
1111
You can download it from the <application>pgSphere</application> homepage
12-
<ulink url="http://pgfoundry.org/projects/pgsphere/"><citetitle>http://pgfoundry.org/projects/pgsphere/</citetitle></ulink>
12+
<ulink url="https://github.com/akorotkov/pgsphere"><citetitle>https://github.com/akorotkov/pgsphere</citetitle></ulink>
1313
</para>
1414
</sect2>
1515

@@ -19,7 +19,7 @@
1919
</title>
2020
<para>
2121
You will need <application>PostgreSQL
22-
7.3</application> or above. We assume that you have
22+
9.1</application> or above. We assume that you have
2323
<application>PostgreSQL</application> already compiled and
2424
installed. Please note: Depending on your system configuration mostly you have to be logged in as the system
2525
superuser.
@@ -97,14 +97,13 @@
9797
<para>
9898
We assume you have already created a database
9999
<database>datab</database>, where <database>datab</database>
100-
is the name of any database. Now change into the directory
101-
<filename>POSTGRESQL_INSTALL_PATH/share/contrib</filename>.
100+
is the name of any database.
102101
Presupposing the name of your
103102
<application>PostgreSQL</application>'s superuser is
104-
<parameter>postgres</parameter> type:
103+
<parameter>postgres</parameter>, type:
105104
</para>
106105
<programlisting>
107-
<![CDATA[shell> psql -U postgres datab < pg_sphere.sql]]>
106+
<![CDATA[shell> psql -U postgres -c 'CREATE EXTENSION pg_sphere;' datab]]>
108107
</programlisting>
109108
<para>
110109
Depending on your system, it may be necessary to give more
@@ -118,7 +117,7 @@
118117
call:
119118
</para>
120119
<programlisting>
121-
<![CDATA[pgsql> SELECT pg_sphere_version()]]>
120+
<![CDATA[pgsql> SELECT pg_sphere_version();]]>
122121
</programlisting>
123122
</sect2>
124123

0 commit comments

Comments
 (0)