add some formatting in README.txt
authorarno <arenevier@fdn.fr>
Sun, 16 Aug 2009 13:38:32 +0000 (15:38 +0200)
committerarno <arenevier@fdn.fr>
Sun, 16 Aug 2009 13:38:32 +0000 (15:38 +0200)
README.txt

index 7c83b4a8ef81b9f5a0f361bb7dd02578f425ef4d..7bad6cf8fa9c8d1d982f120e82c83b7396020ce8 100644 (file)
@@ -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
@@ -65,10 +65,11 @@ Currently, SYP does not allow
 server API
 ----------
 Client/server communication follows an API. This allow for example creation of
-scripts to automate some tasks. This api is described here.
-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.
+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