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 (or postgresql) extension for php
  10 - If mysql is used, it must support spatial extension; mysql version must be >=
  11   4.1 for MyISAM tables or >= 5.0.16 for other tables.
  12 - If postgresql is used, version must be at least 7.4
  13
  14 Installation
  15 ------------
  16
  17 * manual configuration
  18
  19  - edit `inc/settings.php.in` and copy it to `inc/settings.php`
  20  - upload syp to your webserver
  21  - open http://yoururl.com/install.php with your web browser to finalize
  22   installation (database tables creation).
  23
  24 * automatic configuration
  25  - upload syp to your webserver
  26  - open http://yoururl.com/install.php with your web browser and follow
  27   instructions.
  28
  29 For automatic configuration to work, `inc/` directory needs to be writeable. Use
  30 `chmod` to set the appropriate directory permissions. If in doubt, `chmod` to
  31 `0777`. Alternatively, you can use manual method.
  32
  33 Some advanced configuration options are not available with automatic method. If
  34 you need to set those options, use manual configuration.
  35
  36 Upgrade
  37 ------------
  38 - uncompress new version of syp
  39 - upload uncompressed version to your server
  40 - open http://yoururl.com/upgrade.php with your web browser
  41
  42 co-administrators
  43 -----------------
  44 It is possible to allow other people to upload and manage
  45 pictures/descriptions. In admin interface, select "Add an co-administrator"
  46 and fill informations (user name and password). Then, you need to communicate
  47 to your user its username and password. He/She will be able to modify this
  48 password afterward. Only admin can add new users.
  49
  50 Other co-administrators will be able to add markers, and delete/modifiy them.
  51 They cannot modify markers they have not created. admin is the only user
  52 allowed to manage markers of other users. If you plan to have several
  53 co-administrators, you may want to create a normal user for yourself, and use
  54 it to manage your markers. You will then only use admin account when really
  55 needed.
  56
  57 Currently, SYP does not allow
  58
  59 Custom CSS
  60 ----------
  61 You can define your own css rules by creating custom css files:
  62 - `media/syp_custom.css` for user interface
  63 - `media/admin_custom.css` for admin interface
  64 Those files are sourced after all other css files. So, rules defined in those
  65 custom files will override other rules.
  66
  67 server API
  68 ----------
  69 Client/server communication follows an API. This allow for example creation of
  70 scripts to automate some tasks. [API description] [1] is mainly aimed at
  71 developers and inquiring people. You should not need it if you just want to
  72 install syp on your website.
  73
  74 [1]: http://dev.renevier.net/syp.git/?a=blob_plain;f=devdoc/api.txt
  75
  76
  77 Author
  78 ------
  79 Arno Renevier <arno@renevier.net>
  80
  81 Contributor(s):
  82 ---------------
  83     Sebastian Klemm <osm /at/ erlkoenigkabale /dot/ eu> (german translation)