Skip to content
This repository was archived by the owner on Jul 1, 2023. It is now read-only.

Commit a262664

Browse files
committed
Merge pull request #64 from grogy/readme
Update readme
2 parents bedfd62 + b8a2336 commit a262664

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
PHP Parallel Lint
2-
=================
3-
1+
# PHP Parallel Lint
42
This tool check syntax of PHP files faster then serial check with fancier output.
53

64
Running parallel jobs in PHP inspired by Nette framework tests.
75

8-
Install
9-
-------
106

7+
## Install
118
Just create a `composer.json` file and run the `php composer.phar install` command to install it:
129

1310
```json
@@ -29,14 +26,28 @@ For colored output install suggested package `jakub-onderka/php-console-highligh
2926
}
3027
```
3128

32-
Example output
33-
--------------
3429

30+
## Example output
3531
![Alt text](/tests/examples/example-images/use-error.png?raw=true "Example use of tool with error")
3632

37-
Recommended setting for usage with Symfony framework
38-
--------------
3933

34+
## Options for run
35+
- `-p <php>` Specify PHP-CGI executable to run (default: 'php').
36+
- `-s, --short` Set short_open_tag to On (default: Off).
37+
- `-a, -asp` Set asp_tags to On (default: Off).
38+
- `-e <ext>` Check only files with selected extensions separated by comma. (default: php,php3,php4,php5,phtml)
39+
- `--exclude` Exclude directory. If you want exclude multiple directories, use multiple exclude parameters.
40+
- `-j <num>` Run <num> jobs in parallel (default: 10).
41+
- `--no-colors` Disable colors in console output.
42+
- `--json` Output results as JSON string (require PHP 5.4).
43+
- `--blame` Try to show git blame for row with error.
44+
- `--git <git>` Path to Git executable to show blame message (default: 'git').
45+
- `--stdin` Load files and folder to test from standard input.
46+
- `--ignore-fails` Ignore failed tests.
47+
- `-h, --help` Print this help.
48+
49+
50+
## Recommended setting for usage with Symfony framework
4051
For run from command line:
4152

4253
```
@@ -61,8 +72,7 @@ or setting for ANT:
6172
</target>
6273
```
6374

64-
Create Phar package
65-
--------------
75+
## Create Phar package
6676
PHP Parallel Lint supports [Box app](https://box-project.github.io/box2/) for creating Phar package. First, install box app:
6777

6878
```

0 commit comments

Comments
 (0)