Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 63 lines (42 sloc) 3.615 kB
f634bc1 @sebastianbergmann Extract information on how to contribute into separate document.
authored
1 PHPUnit
2 =======
3
4 PHPUnit is the de-facto standard for unit testing in PHP projects. It provides both a framework that makes the writing of tests easy as well as the functionality to easily run the tests and analyse their results.
5
6 Requirements
7 ------------
8
3856371 @sebastianbergmann Open up master branch for new development.
authored
9 * PHPUnit 3.8 requires PHP 5.4.7 (or later).
10 * [PHP_CodeCoverage](http://github.com/sebastianbergmann/php-code-coverage), the library that is used by PHPUnit to collect and process code coverage information, depends on [Xdebug](http://xdebug.org/) 2.2.1 (or later).
f634bc1 @sebastianbergmann Extract information on how to contribute into separate document.
authored
11
12 Installation
13 ------------
14
15 PHPUnit should be installed using the PEAR Installer, the backbone of the [PHP Extension and Application Repository](http://pear.php.net/) that provides a distribution system for PHP packages.
16
17 Depending on your OS distribution and/or your PHP environment, you may need to install PEAR or update your existing PEAR installation before you can proceed with the following instructions. `sudo pear upgrade PEAR` usually suffices to upgrade an existing PEAR installation. The [PEAR Manual ](http://pear.php.net/manual/en/installation.getting.php) explains how to perform a fresh installation of PEAR.
18
19 The following two commands (which you may have to run as `root`) are all that is required to install PHPUnit using the PEAR Installer:
20
21 pear config-set auto_discover 1
22 pear install pear.phpunit.de/PHPUnit
23
24 After the installation you can find the PHPUnit source files inside your local PEAR directory; the path is usually `/usr/lib/php/PHPUnit`.
25
26 Documentation
27 -------------
28
29 The documentation for PHPUnit is available in different formats:
30
ea1defd @sebastianbergmann Link to current documentation.
authored
31 * [English, multiple HTML files](http://www.phpunit.de/manual/current/en/index.html)
32 * [English, single HTML file](http://www.phpunit.de/manual/current/en/phpunit-book.html)
33 * [English, PDF](http://www.phpunit.de/manual/current/en/phpunit-book.pdf)
34 * [English, ePub](http://www.phpunit.de/manual/current/en/phpunit-book.epub)
35 * [French, multiple HTML files](http://www.phpunit.de/manual/current/fr/index.html)
36 * [French, single HTML file](http://www.phpunit.de/manual/current/fr/phpunit-book.html)
37 * [French, PDF](http://www.phpunit.de/manual/current/fr/phpunit-book.pdf)
38 * [French, ePub](http://www.phpunit.de/manual/current/fr/phpunit-book.epub)
39 * [Japanese, multiple HTML files](http://www.phpunit.de/manual/current/ja/index.html)
40 * [Japanese, single HTML file](http://www.phpunit.de/manual/current/ja/phpunit-book.html)
41 * [Japanese, PDF](http://www.phpunit.de/manual/current/ja/phpunit-book.pdf)
42 * [Japanese, ePub](http://www.phpunit.de/manual/current/ja/phpunit-book.epub)
f634bc1 @sebastianbergmann Extract information on how to contribute into separate document.
authored
43
44 IRC
45 ---
46
38ed95b @edorian Fixed irc channel
edorian authored
47 The [#phpunit channel on the Freenode IRC network](irc://irc.freenode.net/phpunit) is a place to chat about PHPUnit.
f634bc1 @sebastianbergmann Extract information on how to contribute into separate document.
authored
48
49 List of Contributors
50 --------------------
51
52 Thanks to everyone who has contributed to PHPUnit! You can find a detailed list of contributors on every PHPUnit related package on GitHub. This list shows only the major components:
53
54 - [PHPUnit](https://github.com/sebastianbergmann/phpunit/graphs/contributors)
55 - [PHP_CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage/graphs/contributors)
56 - [PHPUnit_MockObject](https://github.com/sebastianbergmann/phpunit-mock-objects/graphs/contributors)
57
58 A very special thanks to everyone who has contributed to the documentation and helps maintaining the translations:
59
60 - [PHPUnit Documentation](https://github.com/sebastianbergmann/phpunit-documentation/graphs/contributors)
61
87d0e1a @sebastianbergmann Fix link.
authored
62 Please refer to [CONTRIBUTING.md](https://github.com/sebastianbergmann/phpunit/blob/master/CONTRIBUTING.md) for information on how to contribute to PHPUnit and its related projects.
Something went wrong with that request. Please try again.