Skip to content

Commit a04605c

Browse files
committed
Add README.md
1 parent d6ace58 commit a04605c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:elephant: php-src-devtools :whale:
2+
===================================
3+
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+
5+
Installation
6+
------------
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`.
8+
9+
Usage
10+
-----
11+
In the folder that contains your clone of php-src, run:
12+
* `php-src-devtools build` to build PHP. Note that the initial build may take about an hour.
13+
* `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+
* `php-src-devtools php` to run the compiled PHP CLI, e.g. `php-src-devtools php -i` for phpinfo.
15+
16+
License
17+
-------
18+
The code is released under the MIT license.

0 commit comments

Comments
 (0)