annotate README @ 306:2f472f65d80a gmap2

Make the PHP version requirement more explicit, as we do require 5.6 or newer.
author Matti Hamalainen <ccr@tnsp.org>
date Mon, 11 Sep 2017 13:25:48 +0300
parents 91e6497dffa2
children b5bf0757ca1f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1 Requirements
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 ============
37
d1d602a91826 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 27
diff changeset
3 These are the "hard" requirements.
d1d602a91826 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 27
diff changeset
4
306
2f472f65d80a Make the PHP version requirement more explicit, as we do require 5.6 or newer.
Matti Hamalainen <ccr@tnsp.org>
parents: 302
diff changeset
5 - PHP 5.6+ and the PHP commandline interpreter (notice the latter!)
37
d1d602a91826 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 27
diff changeset
6 - A sane and working /bin/sh (bash, for example)
d1d602a91826 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 27
diff changeset
7 - 'convert' utility of ImageMagick or GraphicsMagick.
95
38cec25e5f36 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
8 - Mercurial (Hg) DVCS.
38cec25e5f36 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
9 - Pupunen Maputils (http://pupunen.net/hg/maputils/) and
38cec25e5f36 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
10 th-libs utility library (http://tnsp.org/hg/th-libs/)
106
c3945b1afa01 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 95
diff changeset
11 and their depencies.
95
38cec25e5f36 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
12
106
c3945b1afa01 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 95
diff changeset
13 NOTICE! Running "makegmaps.php" will automatically fetch maputils
c3945b1afa01 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 95
diff changeset
14 and th-libs, assuming you have Mercurial installed.
27
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
15
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
16
106
c3945b1afa01 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 95
diff changeset
17 How to install
c3945b1afa01 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 95
diff changeset
18 ==============
27
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
19 Steps for producing your own fancy Google Maps -style BatMap:
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
20
132
ace4060171e8 Remove SQL / private/public marker mentions, as I personally deem those
Matti Hamalainen <ccr@tnsp.org>
parents: 106
diff changeset
21 1. Run tools/makegmaps.php:
66
f7a55c9d126b Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 63
diff changeset
22
80
49ae562ce95c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 78
diff changeset
23 $ cd tools
66
f7a55c9d126b Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 63
diff changeset
24 $ php makegmaps.php
27
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
25
213
d42517381b86 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 132
diff changeset
26 If running for the first time, you will be prompted for some data.
d42517381b86 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 132
diff changeset
27
302
91e6497dffa2 No need to make config.inc.php yourself anymore, perhaps just check it.
Matti Hamalainen <ccr@tnsp.org>
parents: 264
diff changeset
28 2. Possibly check/edit config.inc.php , it is generated by makegmaps.php
252
1e1b3d986bfc Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 213
diff changeset
29
1e1b3d986bfc Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 213
diff changeset
30 3. Some web-server configuration may be necessary.
213
d42517381b86 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 132
diff changeset
31
252
1e1b3d986bfc Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 213
diff changeset
32 4. ???
213
d42517381b86 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 132
diff changeset
33
252
1e1b3d986bfc Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 213
diff changeset
34 5. Profit.
213
d42517381b86 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 132
diff changeset
35
27
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
36
213
d42517381b86 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 132
diff changeset
37 How to keep up to date
d42517381b86 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 132
diff changeset
38 ======================
264
649c82460b76 Cosmetics.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
39
254
dc16903bf004 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 252
diff changeset
40 1. To update gmap repo:
264
649c82460b76 Cosmetics.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
41
254
dc16903bf004 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 252
diff changeset
42 $ hg pull && hg up
63
e4733b7da18c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 61
diff changeset
43
254
dc16903bf004 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 252
diff changeset
44 2. For the rest, just run makegmaps.php, it should take care of
dc16903bf004 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 252
diff changeset
45 things automagically.
dc16903bf004 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 252
diff changeset
46
213
d42517381b86 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 132
diff changeset
47 Sometimes it _may_ be necessary to delete contents of tools/cache/
d42517381b86 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 132
diff changeset
48 and/or remove tilecache from tiles/ (achieved most easily by running
d42517381b86 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 132
diff changeset
49 "hg clean --all ." under tiles/ directory.)
63
e4733b7da18c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 61
diff changeset
50