X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=README.md;h=c71e0f654968fb185a72e30b94b59832492142fe;hb=c9cefbfd0f829e992c4aa2a82cc5e98cc5f83a40;hp=d78a196462c01895de995072c45792f26af91c0c;hpb=6a8051340bc468b385e77756625f25137b4a0368;p=plcapi.git diff --git a/README.md b/README.md index d78a196..c71e0f6 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,16 @@ Detailed installation instructions are in the [INSTALL.md](INSTALL.md) file, alo Documentation ------------- -*NB: the user manual has not been updated yet with all the changes made in version 4. Please consider it unreliable!* - -*You are encouraged to look instead the code examples found in the demo/ directory* +See the documentation page at [gggeek.github.io/phpxmlrpc](https://gggeek.github.io/phpxmlrpc) for a list of the +library main features and all project related information. The user manual can be found in the doc/manual directory, in Asciidoc format: [phpxmlrpc_manual.adoc](doc/manual/phpxmlrpc_manual.adoc) -Release tarballs also contain the HTML and PDF versions, as well as an automatically generated API documentation. +Release tarballs also contain HTML and PDF versions of the manual, as well as an automatically generated API documentation. + +*NB: the user manual has not been updated yet with all the changes made in version 4. Please consider it unreliable!* + +*You are encouraged to look instead the code examples found in the demo/ directory* Upgrading --------- @@ -30,19 +33,36 @@ If you are upgrading from version 3 or earlier you have two options: In any case, read carefully the docs in [doc/api_changes_v4.md](doc/api_changes_v4.md) and report back any undocumented issue using GitHub. +Running tests +------------- + +The recommended way to run the library test suite is via the provided Docker containers. +A handy shell script is available that simplifies usage of Docker. + +The full sequence of operations is: + + ./tests/ci/vm.sh build + ./tests/ci/vm.sh start + ./tests/ci/vm.sh runtests + ./tests/ci/vm.sh stop + + # and, once you have finished all testing related work: + ./tests/ci/vm.sh cleanup + +By default tests are run using php 7.0 in a Container based on Ubuntu 16 Xenial. +You can change the version of PHP and Ubuntu in use by setting the environment variables PHP_VERSION and UBUNTU_VERSION +before building the Container. + +To generate the code-coverage report, run `./tests/ci/vm.sh runcoverage` + License ------- Use of this software is subject to the terms in the [license.txt](license.txt) file -SSL-certificate ---------------- -The passphrase for the rsakey.pem certificate is 'test'. - [![License](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/license)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc) [![Latest Stable Version](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/v/stable)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc) [![Total Downloads](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/downloads)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc) -[![Build Status](https://travis-ci.com/gggeek/phpxmlrpc.svg)](https://travis-ci.org/gggeek/phpxmlrpc) -[![Test Coverage](https://codeclimate.com/github/gggeek/phpxmlrpc/badges/coverage.svg)](https://codeclimate.com/github/gggeek/phpxmlrpc) -[![Code Coverage](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/badges/coverage.png?b=php53)](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/?branch=php53) +[![Build Status](https://travis-ci.com/gggeek/phpxmlrpc.svg)](https://travis-ci.com/gggeek/phpxmlrpc) +[![Code Coverage](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/badges/coverage.png)](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc)