From: ggiunta <ggiunta@013ecfd8-0664-425d-a759-9c98391dc3f9>
Date: Wed, 11 Nov 2009 19:29:57 +0000 (+0000)
Subject: - added INSTALL file
X-Git-Tag: 3.0.0~26
X-Git-Url: http://git.onelab.eu/?p=plcapi.git;a=commitdiff_plain;h=1978b0db7ae600aac35a7e5527a26a741e33dc3c

- 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
index 0000000..87ac013
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,38 @@
+XMLRPC for PHP
+
+Requirements
+------------
+
+The following requirements should be met prior to using 'XMLRPC for PHP': 
+. PHP 5.0 or later; 5.0.3 or later recommended to have all functionality enabled
+. the php "curl" extension is needed if you wish to use SSL or HTTP 1.1 to
+  communicate with remote servers
+
+The php "xmlrpc" native extension is not required, but if it is installed,
+there will be no interference with the operation of this library.
+
+
+Installation instructions
+-------------------------
+
+Installation of the library is quite easy:
+
+1. copy the contents of the lib/ folder to any location required by your
+   application (it can be inside the web server root or not).
+
+2. make sure your app can include those files. This can be achieved by setting
+   the PHP include path, either in the php.ini file or directly in the php code
+   of your application, using the 'set_include_path' function
+
+
+Example of php code allowing an application to import the library:
+
+set_include_path(get_include_path() . PATH_SEPARATOR . '/path/to/phpxmlrpc/lib/');
+require_once( 'xmlrpc.inc' );
+require_once( 'xmlrpcs.inc' );
+require_once( 'xmlrpc_wrappers.inc' );
+
+
+Please note that usage of the 'make' command for installation of the library is
+not recommended, as it will generally involve editing of the makefile for a
+succesfull run.
diff --git a/README b/README
index 65a347a..9647aba 100644
--- a/README
+++ b/README
@@ -1,12 +1,14 @@
-NAME: XMLRPC FOR PHP
+NAME: XMLRPC for PHP
 
 DESCRIPTION: A php library for building xmlrpc clients and servers
 
 
 
-HTML documentation can be found in the doc/ directory.
+Installation instructions are in the INSTALL file.
 
-Recent changes in the ChangeLog
+The manual, in HTML and pdf versions, can be found in the doc/ directory.
+
+Recent changes in the ChangeLog file.
 
 Use of this software is subject to the terms in doc/index.html