X-Git-Url: https://dev.renevier.net/gitweb.cgi?p=syp.git;a=blobdiff_plain;f=README.txt;h=bf24c24f5c89e5a291ed4862feb5d6eb69932992;hp=ce452dda99d7730287896d3b50c087585a1cb94a;hb=26f8c80a21aa959fd6731b6c8582d19e13b9d723;hpb=3c74920cb66b4e6c47c7e8a0eaeed40ffb7e8544 diff --git a/README.txt b/README.txt index ce452dd..bf24c24 100644 --- a/README.txt +++ b/README.txt @@ -6,43 +6,37 @@ image and its description. Requirements ------------ - php5 -- mysql extension for php -- mysql must support spatial extension; mysql version must be >= 4.1 for MyISAM - tables or >= 5.0.16 for other tables. I assumed it would not be a problem. - If that's a problem for you, send me a mail, and I'll do without spatial - support. +- mysql (or postgresql) extension for php +- If mysql is used, it must support spatial extension; mysql version must be >= + 4.1 for MyISAM tables or >= 5.0.16 for other tables. +- If postgresql is used, version must be at least 7.4 Installation ------------ * manual configuration -- edit inc/settings.php.in and copy it to inc/settings.php -- upload syp to your webserver -- open http://yoururl.com/install.php with your web browser to finalize + - edit `inc/settings.php.in` and copy it to `inc/settings.php` + - upload syp to your webserver + - open http://yoururl.com/install.php with your web browser to finalize installation (database tables creation). * automatic configuration -- upload syp to your webserver -- open http://yoururl.com/install.php with your web browser and follow + - upload syp to your webserver + - open http://yoururl.com/install.php with your web browser and follow instructions. -For automatic configuration to work, inc/ directory needs to be writeable. Use -chmod to set the appropriate directory permissions. If in doubt, chmod to 0777. -Alternatively, you can use manual method. +For automatic configuration to work, `inc/` directory needs to be writeable. Use +`chmod` to set the appropriate directory permissions. If in doubt, `chmod` to +`0777`. Alternatively, you can use manual method. Some advanced configuration options are not available with automatic method. If you need to set those options, use manual configuration. Upgrade ------------ -- make a copy of inc/settings.php -- make a copy of upload/ (or directory where your photos and thumbnails are stored). -- delete old version of syp from your server -- upload new version -- edit inc/settings.php again (copy old version of file may not be enough - because new settings may have appeared) -- copy upload/ back. +- uncompress new version of syp +- upload uncompressed version to your server - open http://yoururl.com/upgrade.php with your web browser co-administrators @@ -50,7 +44,8 @@ co-administrators It is possible to allow other people to upload and manage pictures/descriptions. In admin interface, select "Add an co-administrator" and fill informations (user name and password). Then, you need to communicate -to your user its username and password. Only admin can add new users. +to your user its username and password. He/She will be able to modify this +password afterward. Only admin can add new users. Other co-administrators will be able to add markers, and delete/modifiy them. They cannot modify markers they have not created. admin is the only user @@ -61,14 +56,28 @@ needed. Currently, SYP does not allow +Custom CSS +---------- +You can define your own css rules by creating custom css files: +- `media/syp_custom.css` for user interface +- `media/admin_custom.css` for admin interface +Those files are sourced after all other css files. So, rules defined in those +custom files will override other rules. + server API ---------- -The way server side communicates with client side is described at -http://dev.renevier.net/syp.git/?a=blob_plain;f=devdoc/api.txt -That document is mainly aimed at developers and inquiring people. You should -not need it if you just want to install syp on your website. +Client/server communication follows an API. This allow for example creation of +scripts to automate some tasks. [API description] [1] is mainly aimed at +developers and inquiring people. You should not need it if you just want to +install syp on your website. + +[1]: http://dev.renevier.net/syp.git/?a=blob_plain;f=devdoc/api.txt Author ------ Arno Renevier + +Contributor(s): +--------------- + Sebastian Klemm (german translation)