Skip to content

Commit 6023638

Browse files
glenscgrogy
authored andcommitted
Improve wording in the readme
- Update Fork section to be neutral and include current fork relation - Improve wording in the rest of the readme - Add git blame as well into readme
1 parent 287d0b4 commit 6023638

File tree

1 file changed

+37
-21
lines changed

1 file changed

+37
-21
lines changed

README.md

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,36 @@
44
[![Build Status](https://travis-ci.org/php-parallel-lint/PHP-Parallel-Lint.svg?branch=master)](https://travis-ci.org/php-parallel-lint/PHP-Parallel-Lint)
55
[![License](https://poser.pugx.org/php-parallel-lint/php-parallel-lint/license.svg)](https://packagist.org/packages/php-parallel-lint/php-parallel-lint)
66

7-
This tool checks syntax of PHP files faster than serial check with a fancier output.
7+
This application checks syntax of PHP files in parallel.
8+
It can output in plain text, colored text, json and checksyntax formats.
9+
Additionally `blame` can be used to show commits that introduced the breakage.
10+
811
Running parallel jobs in PHP is inspired by Nette framework tests.
912

10-
This works from PHP 5.4 to 7.4
13+
The application is officially supported for use with PHP 5.4 to 8.0.
1114

1215
## Table of contents
1316

1417
1. [Installation](#installation)
1518
2. [Example output](#example-output)
16-
3. [Fork](#fork)
17-
4. [Options for run](#options-for-run)
18-
5. [Options for Symfony](#recommended-setting-for-usage-with-symfony-framework)
19+
3. [History](#history)
20+
4. [Command line options](#command-line-options)
21+
5. [Recommended excludes for Symfony framework](#recommended-excludes-for-symfony-framework)
1922
6. [Create Phar package](#create-phar-package)
20-
7. [How upgrade](#how-upgrade)
23+
7. [How to upgrade](#how-to-upgrade)
2124

2225
## Installation
2326

24-
Just run the following command to install it:
27+
Install with `composer` as development dependency:
2528

2629
composer require --dev php-parallel-lint/php-parallel-lint
2730

28-
When you cannot use tool as dependency then you can install as project. Command for it:
31+
Alternatively you can install as a standalone `composer` project:
2932

3033
composer create-project php-parallel-lint/php-parallel-lint /path/to/folder/php-parallel-lint
3134
/path/to/folder/php-parallel-lint/parallel-lint # running tool
3235

33-
For colored output also install the suggested package `php-parallel-lint/php-console-highlighter`:
36+
For colored output, install the suggested package `php-parallel-lint/php-console-highlighter`:
3437

3538
composer require --dev php-parallel-lint/php-console-highlighter
3639

@@ -39,14 +42,27 @@ For colored output also install the suggested package `php-parallel-lint/php-con
3942
![Example use of tool with error](/tests/examples/example-images/use-error.png?raw=true "Example use of tool with error")
4043

4144

42-
## Fork
43-
This is a fork of [original project](https://github.com/JakubOnderka/PHP-Parallel-Lint). Why I forked it and why I am the right man?
45+
## History
46+
47+
This project was originally created by [@JakubOnderka] and released as
48+
[jakub-onderka/php-parallel-lint].
49+
50+
Since then, Jakub has moved on to other interests and as of January 2020, the
51+
second most active maintainer [@grogy] has taken over maintenance of the project
52+
and given the project - and related dependencies - a new home in the PHP
53+
Parallel Lint organisation.
54+
55+
It is strongly recommended for existing users of the (unmaintained)
56+
[jakub-onderka/php-parallel-lint] package to switch their dependency to
57+
[php-parallel-lint/php-parallel-lint].
4458

45-
- Project is used in many and projects.
46-
- I am [second most active](https://github.com/JakubOnderka/PHP-Parallel-Lint/graphs/contributors) contributor in original project.
47-
- Author does [not responds to issues and PRs](https://github.com/JakubOnderka/PHP-Parallel-Lint/pulls) and my mail messages.
59+
[php-parallel-lint/php-parallel-lint]: https://github.com/php-parallel-lint/PHP-Parallel-Lint
60+
[grogy/php-parallel-lint]: https://github.com/grogy/PHP-Parallel-Lint
61+
[jakub-onderka/php-parallel-lint]: https://github.com/JakubOnderka/PHP-Parallel-Lint
62+
[@JakubOnderka]: https://github.com/JakubOnderka
63+
[@grogy]: https://github.com/grogy
4864

49-
## Options for run
65+
## Command line options
5066

5167
- `-p <php>` Specify PHP-CGI executable to run (default: 'php').
5268
- `-s, --short` Set short_open_tag to On (default: Off).
@@ -58,7 +74,7 @@ This is a fork of [original project](https://github.com/JakubOnderka/PHP-Paralle
5874
- `--no-colors` Disable colors in console output.
5975
- `--no-progress` Disable progress in console output.
6076
- `--checkstyle` Output results as Checkstyle XML.
61-
- `--json` Output results as JSON string (require PHP 5.4).
77+
- `--json` Output results as JSON string (requires PHP 5.4).
6278
- `--blame` Try to show git blame for row with error.
6379
- `--git <git>` Path to Git executable to show blame message (default: 'git').
6480
- `--stdin` Load files and folder to test from standard input.
@@ -68,9 +84,9 @@ This is a fork of [original project](https://github.com/JakubOnderka/PHP-Paralle
6884
- `-V, --version` Display this application version.
6985

7086

71-
## Recommended setting for usage with Symfony framework
87+
## Recommended excludes for Symfony framework
7288

73-
For run from command line:
89+
To run from the command line:
7490

7591
vendor/bin/parallel-lint --exclude app --exclude vendor .
7692

@@ -82,14 +98,14 @@ PHP Parallel Lint supports [Box app](https://box-project.github.io/box2/) for cr
8298
curl -LSs https://box-project.github.io/box2/installer.php | php
8399

84100

85-
and then run this command in parallel lint folder, which creates `parallel-lint.phar` file.
101+
then run the build command in parallel lint folder, which creates `parallel-lint.phar` file.
86102

87103

88104
box build
89105

90-
## How upgrade
106+
## How to upgrade
91107

92-
Are you using original package? You can easy use this fork. Steps for upgrade are:
108+
Are you using `jakub-onderka/php-parallel-lint` package? You can switch to `php-parallel-lint/php-parallel-lint` using:
93109

94110
composer remove --dev jakub-onderka/php-parallel-lint
95111
composer require --dev php-parallel-lint/php-parallel-lint

0 commit comments

Comments
 (0)