]> dev.renevier.net Git - syp.git/blob - README.txt
33f29a31362a9c3b15f28a875e0c7e21f378f415
[syp.git] / README.txt
1 Show Your Places (SYP) is a web CMS whose goal is to manage a pictures or
2 photos collection with geographic location. The website shows a map with
3 markers matching picture locations. When selecting a marker, visitors can see
4 image and its description.
5
6 Requirements
7 ------------
8 - php5
9 - mysql extension for php
10 - mysql must support spatial extension; mysql version must be >= 4.1 for MyISAM
11   tables or >= 5.0.16 for other tables. I assumed it would not be a problem.
12   If that's a problem for you, send me a mail, and I'll do without spatial
13   support.
14
15 Installation
16 ------------
17
18 * manual configuration
19
20 - edit inc/settings.php.in and copy it to inc/settings.php
21 - upload syp to your webserver
22 - open http://yoururl.com/install.php with your web browser to finalize
23   installation (database tables creation).
24
25 * automatic configuration
26 - upload syp to your webserver
27 - open http://yoururl.com/install.php with your web browser and follow
28   instructions.
29
30 For automatic configuration to work, inc/ directory needs to be writeable. Use
31 chmod to set the appropriate directory permissions. If in doubt, chmod to 0777.
32 Alternatively, you can use manual method.
33
34 Some advanced configuration options are not available with automatic method. If
35 you need to set those options, use manual configuration.
36
37 Upgrade
38 ------------
39 - make a copy of inc/settings.php
40 - make a copy of upload/ (or directory where your photos and thumbnails are stored).
41 - delete old version of syp from your server
42 - upload new version
43 - edit inc/settings.php again (copy old version of file may not be enough
44   because new settings may have appeared)
45 - copy upload/ back.
46 - open http://yoururl.com/upgrade.php with your web browser
47
48 server API
49 ----------
50 The way server side communicates with client side is described at
51 http://dev.renevier.net/syp.git/?a=blob_plain;f=devdoc/api.txt
52 That document is mainly aimed at developers and inquiring people. You should
53 not need it if you just want to install syp on your website.
54
55
56 Author
57 ------
58 Arno Renevier <arno@renevier.net>