|
| 1 | +[](https://packagist.org/packages/aboks/php-src-devtools) |
| 2 | + |
1 | 3 | :elephant: php-src-devtools :whale: |
2 | 4 | =================================== |
3 | 5 | Tools to make it easier to contribute to PHP itself ([php-src](https://github.com/php/php-src)). Uses Docker containers for building, running and testing PHP from source. |
4 | 6 |
|
| 7 | +Prerequisites |
| 8 | +------------- |
| 9 | +Ensure that [Docker](https://www.docker.com/get-docker) is installed and running on your system. |
| 10 | + |
5 | 11 | Installation |
6 | 12 | ------------ |
7 | | -Ensure that [Docker](https://www.docker.com/get-docker) is installed and running on your system. Clone or download this repository somewhere, and ensure that `php-src-devtools` is on your `PATH`. |
| 13 | +The easiest way to install this tool is as a global composer package: |
| 14 | +``` |
| 15 | +$ composer global require aboks/php-src-devtools |
| 16 | +``` |
| 17 | + |
| 18 | +Alternatively, clone or download this repository somewhere, run `composer install` to install dependencies, and ensure that `php-src-devtools` is on your `PATH`. |
8 | 19 |
|
9 | 20 | Usage |
10 | 21 | ----- |
11 | 22 | In the folder that contains your clone of php-src, run: |
12 | 23 | * `php-src-devtools build` to build PHP. Note that the initial build may take about an hour. |
13 | 24 | * `php-src-devtools test` to run the full PHP testsuite. You can use `php-src-devtools test path/to/test.phpt` to run a single test, or `php-src-devtools test ext/foo` to test a single extension. |
14 | 25 | * `php-src-devtools php` to run the compiled PHP CLI, e.g. `php-src-devtools php -i` for phpinfo. |
| 26 | +* `php-src-devtools list` to see all subcommands, or `php-src-devtools help` for additional help. |
| 27 | + |
| 28 | +Versioning |
| 29 | +---------- |
| 30 | +This project adheres to [Semantic Versioning](http://semver.org/). |
15 | 31 |
|
16 | 32 | License |
17 | 33 | ------- |
|
0 commit comments