Skip to content

Commit b4e044c

Browse files
committed
Small fixes in Readme
1 parent 3b76ca0 commit b4e044c

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.md

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

4-
Running parallel jobs in PHP inspired by Nette framework tests.
3+
This tool checks syntax of PHP files faster than serial check with a fancier output.
4+
5+
Running parallel jobs in PHP is inspired by Nette framework tests.
56

67
## Install
8+
79
Just run the following command to install it:
810

911
composer require --dev jakub-onderka/php-parallel-lint
@@ -13,32 +15,36 @@ For colored output install the suggested package `jakub-onderka/php-console-high
1315
composer require --dev jakub-onderka/php-console-highlighter
1416

1517
## Example output
16-
![Alt text](/tests/examples/example-images/use-error.png?raw=true "Example use of tool with error")
18+
19+
![Example use of tool with error](/tests/examples/example-images/use-error.png?raw=true "Example use of tool with error")
1720

1821

1922
## Options for run
23+
2024
- `-p <php>` Specify PHP-CGI executable to run (default: 'php').
2125
- `-s, --short` Set short_open_tag to On (default: Off).
22-
- `-a, -asp` Set asp_tags to On (default: Off).
26+
- `-a, --asp` Set asp_tags to On (default: Off).
2327
- `-e <ext>` Check only files with selected extensions separated by comma. (default: php,php3,php4,php5,phtml)
2428
- `--exclude` Exclude a file or directory. If you want exclude multiple items, use multiple exclude parameters.
2529
- `-j <num>` Run <num> jobs in parallel (default: 10).
30+
- `--colors` Force enable colors in console output.
2631
- `--no-colors` Disable colors in console output.
2732
- `--json` Output results as JSON string (require PHP 5.4).
2833
- `--blame` Try to show git blame for row with error.
2934
- `--git <git>` Path to Git executable to show blame message (default: 'git').
3035
- `--stdin` Load files and folder to test from standard input.
3136
- `--ignore-fails` Ignore failed tests.
3237
- `-h, --help` Print this help.
33-
- `-V, --version` Display this application version
38+
- `-V, --version` Display this application version.
3439

3540

3641
## Recommended setting for usage with Symfony framework
42+
3743
For run from command line:
3844

39-
```
40-
./bin/parallel-lint --exclude app --exclude vendor .
41-
```
45+
46+
./bin/parallel-lint --exclude app --exclude vendor .
47+
4248

4349
or setting for ANT:
4450

@@ -59,17 +65,18 @@ or setting for ANT:
5965
```
6066

6167
## Create Phar package
68+
6269
PHP Parallel Lint supports [Box app](https://box-project.github.io/box2/) for creating Phar package. First, install box app:
6370

64-
```
65-
curl -LSs https://box-project.github.io/box2/installer.php | php
66-
```
71+
72+
curl -LSs https://box-project.github.io/box2/installer.php | php
73+
6774

6875
and then run this command in parallel lint folder, which creates `parallel-lint.phar` file.
6976

70-
```
71-
box build
72-
```
77+
78+
box build
79+
7380

7481
------
7582

0 commit comments

Comments
 (0)