Permalink
Browse files

Extract information on how to contribute into separate document.

  • Loading branch information...
sebastianbergmann committed Sep 17, 2012
1 parent 65914b0 commit f634bc1e6c2809f2dbf60eb7e3f90f89a9183561
Showing with 117 additions and 121 deletions.
  1. +55 −0 CONTRIBUTING.md
  2. 0 ChangeLog.markdown → ChangeLog.md
  3. +0 −121 README.markdown
  4. +62 −0 README.md
View
@@ -0,0 +1,55 @@
+Contributing to PHPUnit
+=======================
+
+Contributions to PHPUnit, its related modules, and its documentation are always welcome. You make our lifes easier by sending us your contributions through GitHub pull requests.
+
+Please note that the `3.6.` branch is closed for features and that pull requests should to be based on `master` or the `3.7.` once it exists.
+
+We are trying to keep backwards compatibility breaks in PHPUnit 3.7 to an absolute minimum so please take this into account when proposing changes.
+
+Due to time constraints, we are not always able to respond as quickly as we would like. Please do not take delays personal and feel free to remind us here or on IRC if you feel that we forgot to respond.
+
+Using PHPUnit From a Git Checkout
+---------------------------------
+
+The following commands can be used to perform the initial checkout of PHPUnit and its dependencies from Git:
+
+ mkdir phpunit && cd phpunit
+ git clone git://github.com/sebastianbergmann/phpunit.git
+ git clone git://github.com/sebastianbergmann/dbunit.git
+ git clone git://github.com/sebastianbergmann/php-file-iterator.git
+ git clone git://github.com/sebastianbergmann/php-text-template.git
+ git clone git://github.com/sebastianbergmann/php-code-coverage.git
+ git clone git://github.com/sebastianbergmann/php-token-stream.git
+ git clone git://github.com/sebastianbergmann/php-timer.git
+ git clone git://github.com/sebastianbergmann/phpunit-mock-objects.git
+ git clone git://github.com/sebastianbergmann/phpunit-selenium.git
+ git clone git://github.com/sebastianbergmann/phpunit-story.git
+ git clone git://github.com/sebastianbergmann/php-invoker.git
+
+The `dbunit`, `php-code-coverage`, `php-file-iterator`, `php-text-template`, `php-timer`, `php-token-stream`, `phpunit`, `phpunit-mock-objects`, `phpunit-selenium`, `phpunit-story`, and `php-invoker` directories need to be added to the `include_path`.
+
+In addition to the checkouts listed above, the YAML component that is provided by the Symfony project is required:
+
+ pear install pear.symfony.com/Yaml
+
+The `phpunit/phpunit.php` script can be used to invoke the PHPUnit test runner.
+
+Running the test suite(s)
+-------------------------
+
+It is not possible to use a system-wide installed version of PHPUnit to run the test suite of a Git checkout. Because of that is is necessary to change the `include_paths` as described below.
+
+This can be achieved with a small wrapper script designed to work with every module in the PHPUnit stack.
+
+Note that you might have to change the path to your PEAR installation here pointing to `/usr/local/lib/php`. You can find it using `pear config-show | grep php_dir`.
+
+### Linux / MacOS X
+
+ #!/bin/bash
+ php -d include_path='.:../phpunit/:../dbunit/:../php-code-coverage/:../php-file-iterator/:../php-invoker/:../php-text-template/:../php-timer:../php-token-stream:../phpunit-mock-objects/:../phpunit-selenium/:../phpunit-story/:/usr/local/lib/php' ../phpunit/phpunit.php $*
+
+### Windows
+
+ @echo off
+ php -d include_path='.;../phpunit/;../dbunit/;../php-code-coverage/;../php-file-iterator/;../php-invoker/;../php-text-template/;../php-timer;../php-token-stream;../phpunit-mock-objects/;../phpunit-selenium/;../phpunit-story/;C:/Program Files/PHP/pear' ../phpunit/phpunit.php %*
File renamed without changes.
View
@@ -1,121 +0,0 @@
-PHPUnit
-=======
-
-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.
-
-Requirements
-------------
-
-* PHPUnit 3.7 requires PHP 5.3.3 (or later) but PHP 5.4.6 (or later) is highly recommended.
-* [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.0.5 (or later) but Xdebug 2.2.1 (or later) is highly recommended.
-
-Installation
-------------
-
-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.
-
-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.
-
-The following two commands (which you may have to run as `root`) are all that is required to install PHPUnit using the PEAR Installer:
-
- pear config-set auto_discover 1
- pear install pear.phpunit.de/PHPUnit
-
-After the installation you can find the PHPUnit source files inside your local PEAR directory; the path is usually `/usr/lib/php/PHPUnit`.
-
-Documentation
--------------
-
-The documentation for PHPUnit is available in different formats:
-
-* [English, multiple HTML files](http://www.phpunit.de/manual/3.7/en/index.html)
-* [English, single HTML file](http://www.phpunit.de/manual/3.7/en/phpunit-book.html)
-* [English, PDF](http://www.phpunit.de/manual/3.7/en/phpunit-book.pdf)
-* [English, ePub](http://www.phpunit.de/manual/3.7/en/phpunit-book.epub)
-* [French, multiple HTML files](http://www.phpunit.de/manual/3.7/fr/index.html)
-* [French, single HTML file](http://www.phpunit.de/manual/3.7/fr/phpunit-book.html)
-* [French, PDF](http://www.phpunit.de/manual/3.7/fr/phpunit-book.pdf)
-* [French, ePub](http://www.phpunit.de/manual/3.7/fr/phpunit-book.epub)
-* [Japanese, multiple HTML files](http://www.phpunit.de/manual/3.7/ja/index.html)
-* [Japanese, single HTML file](http://www.phpunit.de/manual/3.7/ja/phpunit-book.html)
-* [Japanese, PDF](http://www.phpunit.de/manual/3.7/ja/phpunit-book.pdf)
-* [Japanese, ePub](http://www.phpunit.de/manual/3.7/ja/phpunit-book.epub)
-
-IRC
----
-
-The [#phpunit channel on the Freenode IRC network](irc://freenode.net/phpunit) is a place to chat about PHPUnit.
-
-Using PHPUnit From a Git Checkout
----------------------------------
-
-The following commands can be used to perform the initial checkout of PHPUnit and its dependencies from Git:
-
- mkdir phpunit && cd phpunit
- git clone git://github.com/sebastianbergmann/phpunit.git
- git clone git://github.com/sebastianbergmann/dbunit.git
- git clone git://github.com/sebastianbergmann/php-file-iterator.git
- git clone git://github.com/sebastianbergmann/php-text-template.git
- git clone git://github.com/sebastianbergmann/php-code-coverage.git
- git clone git://github.com/sebastianbergmann/php-token-stream.git
- git clone git://github.com/sebastianbergmann/php-timer.git
- git clone git://github.com/sebastianbergmann/phpunit-mock-objects.git
- git clone git://github.com/sebastianbergmann/phpunit-selenium.git
- git clone git://github.com/sebastianbergmann/phpunit-story.git
- git clone git://github.com/sebastianbergmann/php-invoker.git
-
-The `dbunit`, `php-code-coverage`, `php-file-iterator`, `php-text-template`, `php-timer`, `php-token-stream`, `phpunit`, `phpunit-mock-objects`, `phpunit-selenium`, `phpunit-story`, and `php-invoker` directories need to be added to the `include_path`.
-
-In addition to the checkouts listed above, the YAML component that is provided by the Symfony project is required:
-
- pear install pear.symfony.com/Yaml
-
-The `phpunit/phpunit.php` script can be used to invoke the PHPUnit test runner.
-
-Contributing
-------------
-
-Contributions to PHPUnit, its related modules and its documentation are always welcome and best done using GitHub pull request.
-
-Please note that the `3.6.` branch is closed for features and that pull requests should to be based on `master` or the `3.7.` once it exists.
-
-We are trying to keep BC breaks in PHPUnit 3.7 to a absolute minimum so please take this into account when proposing changes.
-
-Due to time constraints we are not always able to respond as quickly as we'd like to so please do not take delays personal and feel free to remind us here or on IRC if you feel that we forgot to respond.
-
-### List of Contributors
-
-Thanks to everyone that has contributed to PHPUnit! You can find a detailed contributors list on every PHPUnit related package on GitHub. This list shows only the bigger components:
-
-- [PHPUnit core](https://github.com/sebastianbergmann/phpunit/graphs/contributors)
-- [PHP code coverage](https://github.com/sebastianbergmann/php-code-coverage/graphs/contributors)
-- [PHPUnit mock objects](https://github.com/sebastianbergmann/phpunit-mock-objects/graphs/contributors)
-
-A very special thanks to everyone that has contributed to the documentation and helped maintaining the translations:
-
-- [PHPUnit Documentation](https://github.com/sebastianbergmann/phpunit-documentation/graphs/contributors)
-
-### Running the test suite(s)
-
-It's not possible to use a system wide installed version of PHPUnit to run the test suite of a git checkout. Because of that is is necessary to change the include paths like describe above.
-
-This can be achieved with a small wrapper script designed to work with every module in the PHPUnit stack.
-
-Note that you might have to change the path to your pear installation here pointing to `/usr/local/lib/php`. You can find it using `pear config-show | grep php_dir`
-
-**Linux/Mac**
-
-`run-tests.sh`
-
-> \#!/bin/bash
->
-> php -d include_path='.:../phpunit/:../dbunit/:../php-code-coverage/:../php-file-iterator/:../php-invoker/:../php-text-template/:../php-timer:../php-token-stream:../phpunit-mock-objects/:../phpunit-selenium/:../phpunit-story/:/usr/local/lib/php' ../phpunit/phpunit.php $*
-
-**Windows**
-
-`run-tests.bat`
-
-> @echo off
->
-> php -d include_path='.;../phpunit/;../dbunit/;../php-code-coverage/;../php-file-iterator/;../php-invoker/;../php-text-template/;../php-timer;../php-token-stream;../phpunit-mock-objects/;../phpunit-selenium/;../phpunit-story/;C:/Program Files/PHP/pear' ../phpunit/phpunit.php %*
-
View
@@ -0,0 +1,62 @@
+PHPUnit
+=======
+
+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.
+
+Requirements
+------------
+
+* PHPUnit 3.7 requires PHP 5.3.3 (or later) but PHP 5.4.6 (or later) is highly recommended.
+* [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.0.5 (or later) but Xdebug 2.2.1 (or later) is highly recommended.
+
+Installation
+------------
+
+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.
+
+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.
+
+The following two commands (which you may have to run as `root`) are all that is required to install PHPUnit using the PEAR Installer:
+
+ pear config-set auto_discover 1
+ pear install pear.phpunit.de/PHPUnit
+
+After the installation you can find the PHPUnit source files inside your local PEAR directory; the path is usually `/usr/lib/php/PHPUnit`.
+
+Documentation
+-------------
+
+The documentation for PHPUnit is available in different formats:
+
+* [English, multiple HTML files](http://www.phpunit.de/manual/3.7/en/index.html)
+* [English, single HTML file](http://www.phpunit.de/manual/3.7/en/phpunit-book.html)
+* [English, PDF](http://www.phpunit.de/manual/3.7/en/phpunit-book.pdf)
+* [English, ePub](http://www.phpunit.de/manual/3.7/en/phpunit-book.epub)
+* [French, multiple HTML files](http://www.phpunit.de/manual/3.7/fr/index.html)
+* [French, single HTML file](http://www.phpunit.de/manual/3.7/fr/phpunit-book.html)
+* [French, PDF](http://www.phpunit.de/manual/3.7/fr/phpunit-book.pdf)
+* [French, ePub](http://www.phpunit.de/manual/3.7/fr/phpunit-book.epub)
+* [Japanese, multiple HTML files](http://www.phpunit.de/manual/3.7/ja/index.html)
+* [Japanese, single HTML file](http://www.phpunit.de/manual/3.7/ja/phpunit-book.html)
+* [Japanese, PDF](http://www.phpunit.de/manual/3.7/ja/phpunit-book.pdf)
+* [Japanese, ePub](http://www.phpunit.de/manual/3.7/ja/phpunit-book.epub)
+
+IRC
+---
+
+The [#phpunit channel on the Freenode IRC network](irc://freenode.net/phpunit) is a place to chat about PHPUnit.
+
+List of Contributors
+--------------------
+
+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:
+
+- [PHPUnit](https://github.com/sebastianbergmann/phpunit/graphs/contributors)
+- [PHP_CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage/graphs/contributors)
+- [PHPUnit_MockObject](https://github.com/sebastianbergmann/phpunit-mock-objects/graphs/contributors)
+
+A very special thanks to everyone who has contributed to the documentation and helps maintaining the translations:
+
+- [PHPUnit Documentation](https://github.com/sebastianbergmann/phpunit-documentation/graphs/contributors)
+
+Please refer to [CONTRIBUTING.md](https://github.com/sebastianbergmann/phpunit/blob/master/CONTRIBUTING.markdown) for information on how to contribute to PHPUnit and its related projects.

0 comments on commit f634bc1

Please sign in to comment.