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
  32 `0777`. 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 - uncompress new version of syp
  40 - upload uncompressed version to your server
  41 - open http://yoururl.com/upgrade.php with your web browser
  42
  43 co-administrators
  44 -----------------
  45 It is possible to allow other people to upload and manage
  46 pictures/descriptions. In admin interface, select "Add an co-administrator"
  47 and fill informations (user name and password). Then, you need to communicate
  48 to your user its username and password. He/She will be able to modify this
  49 password afterward. Only admin can add new users.
  50
  51 Other co-administrators will be able to add markers, and delete/modifiy them.
  52 They cannot modify markers they have not created. admin is the only user
  53 allowed to manage markers of other users. If you plan to have several
  54 co-administrators, you may want to create a normal user for yourself, and use
  55 it to manage your markers. You will then only use admin account when really
  56 needed.
  57
  58 Currently, SYP does not allow
  59
  60 Custom CSS
  61 ----------
  62 You can define your own css rules by creating custom css files:
  63 - `media/syp_custom.css` for user interface
  64 - `media/admin_custom.css` for admin interface
  65 Those files are sourced after all other css files. So, rules defined in those
  66 custom files will override other rules.
  67
  68 server API
  69 ----------
  70 Client/server communication follows an API. This allow for example creation of
  71 scripts to automate some tasks. [API description] [1] is mainly aimed at
  72 developers and inquiring people. You should not need it if you just want to
  73 install syp on your website.
  74
  75 [1]: http://dev.renevier.net/syp.git/?a=blob_plain;f=devdoc/api.txt
  76
  77
  78 Author
  79 ------
  80 Arno Renevier <arno@renevier.net>
  81
  82 Contributor(s):
  83 ---------------
  84     Sebastian Klemm <osm /at/ erlkoenigkabale /dot/ eu> (german translation)