- added INSTALL file

git-svn-id: https://svn.code.sf.net/p/phpxmlrpc/code/trunk/xmlrpc@71 013ecfd8-0664-425d-a759-9c98391dc3f9

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..87ac013
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,38 @@
+XMLRPC for PHP\r
+\r
+Requirements\r
+------------\r
+\r
+The following requirements should be met prior to using 'XMLRPC for PHP': \r
+. PHP 5.0 or later; 5.0.3 or later recommended to have all functionality enabled\r
+. the php "curl" extension is needed if you wish to use SSL or HTTP 1.1 to\r
+  communicate with remote servers\r
+\r
+The php "xmlrpc" native extension is not required, but if it is installed,\r
+there will be no interference with the operation of this library.\r
+\r
+\r
+Installation instructions\r
+-------------------------\r
+\r
+Installation of the library is quite easy:\r
+\r
+1. copy the contents of the lib/ folder to any location required by your\r
+   application (it can be inside the web server root or not).\r
+\r
+2. make sure your app can include those files. This can be achieved by setting\r
+   the PHP include path, either in the php.ini file or directly in the php code\r
+   of your application, using the 'set_include_path' function\r
+\r
+\r
+Example of php code allowing an application to import the library:\r
+\r
+set_include_path(get_include_path() . PATH_SEPARATOR . '/path/to/phpxmlrpc/lib/');\r
+require_once( 'xmlrpc.inc' );\r
+require_once( 'xmlrpcs.inc' );\r
+require_once( 'xmlrpc_wrappers.inc' );\r
+\r
+\r
+Please note that usage of the 'make' command for installation of the library is\r
+not recommended, as it will generally involve editing of the makefile for a\r
+succesfull run.\r

diff --git a/README b/README
index 65a347a..9647aba 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,14 @@
-NAME: XMLRPC FOR PHP\r
+NAME: XMLRPC for PHP\r
 \r
 DESCRIPTION: A php library for building xmlrpc clients and servers\r
 \r
 \r
 \r
-HTML documentation can be found in the doc/ directory.\r
+Installation instructions are in the INSTALL file.\r
 \r
-Recent changes in the ChangeLog\r
+The manual, in HTML and pdf versions, can be found in the doc/ directory.\r
+\r
+Recent changes in the ChangeLog file.\r
 \r
 Use of this software is subject to the terms in doc/index.html\r
 \r