Update makefile for docs:
[plcapi.git] / INSTALL
1 XMLRPC for PHP\r
2 \r
3 Requirements\r
4 ------------\r
5 \r
6 The following requirements should be met prior to using 'XMLRPC for PHP': \r
7 . PHP 5.0 or later; 5.0.3 or later recommended to have all functionality enabled\r
8 . the php "curl" extension is needed if you wish to use SSL or HTTP 1.1 to\r
9   communicate with remote servers\r
10 \r
11 The php "xmlrpc" native extension is not required, but if it is installed,\r
12 there will be no interference with the operation of this library.\r
13 \r
14 \r
15 Installation instructions\r
16 -------------------------\r
17 \r
18 Installation of the library is quite easy:\r
19 \r
20 1. copy the contents of the lib/ folder to any location required by your\r
21    application (it can be inside the web server root or not).\r
22 \r
23 2. make sure your app can include those files. This can be achieved by setting\r
24    the PHP include path, either in the php.ini file or directly in the php code\r
25    of your application, using the 'set_include_path' function\r
26 \r
27 \r
28 Example of php code allowing an application to import the library:\r
29 \r
30 set_include_path(get_include_path() . PATH_SEPARATOR . '/path/to/phpxmlrpc/lib/');\r
31 require_once( 'xmlrpc.inc' );\r
32 require_once( 'xmlrpcs.inc' );\r
33 require_once( 'xmlrpc_wrappers.inc' );\r
34 \r
35 \r
36 Please note that usage of the 'make' command for installation of the library is\r
37 not recommended, as it will generally involve editing of the makefile for a\r
38 succesfull run.\r