X-Git-Url: https://dev.renevier.net/gitweb.cgi?p=syp.git;a=blobdiff_plain;f=README.txt;h=7bad6cf8fa9c8d1d982f120e82c83b7396020ce8;hp=ccd1f04a815d19ad409514858f3690bf37effd64;hb=1eff14d093d541d9858f73ffca042de5a2bf3ea5;hpb=939514b912738c5784b04a0d207db1afd918eb69 diff --git a/README.txt b/README.txt index ccd1f04..7bad6cf 100644 --- a/README.txt +++ b/README.txt @@ -17,32 +17,32 @@ 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). +- 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 +- edit `inc/settings.php` again (copy old version of file may not be enough because new settings may have appeared) -- copy upload/ back. +- copy `upload/` back. - open http://yoururl.com/upgrade.php with your web browser co-administrators @@ -64,10 +64,12 @@ Currently, SYP does not allow 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