[Summary view] [Print] [Text view]

   1  ################################################################################
   2  #  $Id: README 14009 2005-03-16 17:33:33Z npac $
   3  #  
   4  #  Copyright(c) 2004-2005, SpikeSource Inc. All Rights Reserved.
   5  #  Licensed under the Open Source License version 2.1
   6  #  (See http://www.spikesource.com/license.html)
   7  ################################################################################
   8  
   9  ===========================
  10    Spike PHPCoverage 0.6.6 
  11  ===========================
  12  
  13  1. Introduction
  14  ===============
  15  
  16    Spike PHPCoverage is an open-source tool for measuring and reporting code 
  17    coverage provided by the test suite of a PHP application. 
  18    Spike PHPCoverage can instrument and record the line coverage information 
  19    for any PHP script at runtime.
  20  
  21    Spike PHPCoverage also provides an extensible reporting mechanism with a 
  22    standard HTML report implemented out of the box. The default report 
  23    displays the summary information about the code coverage for an application 
  24    and also shows the detailed information about a file including which 
  25    lines were actually executed and with what frequency. It is possible 
  26    to specify the directories and files that should be included and/or 
  27    excluded from a coverage measurement. Screen shots of the summary and 
  28    detailed line coverage reports are available at 
  29    http://www.spikesource.com/projects/phpcoverage/screenshots.php
  30  
  31    Spike PHPCoverage works on PHP 5.0 and newer and uses XDebug Zend Extension 
  32    for gathering the coverage data.
  33  
  34  
  35  2. Requirements
  36  ===============
  37  
  38    * PHP 5.0 or newer
  39    * Xdebug Zend Extension configured with PHP
  40    * XML_Parser PEAR module version 1.2.5 or newer
  41    * Web browser to view the coverage report
  42  
  43  3. Frequently Asked Questions
  44  =============================
  45    See http://developer.spikesource.com/wiki/index.php/Projects:phpcoverageFAQ for latest FAQs.
  46  
  47  4. API Documentation
  48  ====================
  49  
  50    Spike PHPCoverage API Documentation is available with this distribution under the 'doc'
  51    directory. A latest version is also available online at 
  52    http://www.spikesource.com/projects/phpcoverage/doc/index.html
  53