Skip to content

Commit b2ccc18

Browse files
committed
Update README
1 parent e2d0583 commit b2ccc18

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

100644100755
Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,33 @@
1+
[![Latest Stable Version](https://poser.pugx.org/aboks/php-src-devtools/v/stable)](https://packagist.org/packages/aboks/php-src-devtools)
2+
13
:elephant: php-src-devtools :whale:
24
===================================
35
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.
46

7+
Prerequisites
8+
-------------
9+
Ensure that [Docker](https://www.docker.com/get-docker) is installed and running on your system.
10+
511
Installation
612
------------
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`.
819

920
Usage
1021
-----
1122
In the folder that contains your clone of php-src, run:
1223
* `php-src-devtools build` to build PHP. Note that the initial build may take about an hour.
1324
* `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.
1425
* `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/).
1531

1632
License
1733
-------

0 commit comments

Comments
 (0)