|
1 | | -Extension Pre-Validator |
2 | | -======================= |
| 1 | +# Extension Pre-Validator |
3 | 2 |
|
4 | 3 | [](https://github.com/phpbb/epv/actions) |
5 | 4 |
|
6 | 5 | This repository contains the extension pre-validator, used for pre validating extensions when submittion to the database at phpBB.com. |
7 | 6 |
|
8 | | -Please note that EPV requires at least PHP 5.5 |
| 7 | +Please note that EPV requires at least PHP 7.2 |
9 | 8 |
|
10 | | -Using EPV |
11 | | ---------- |
12 | | - |
13 | | -1. Clone the repository |
14 | | -1. Run: |
| 9 | +## Using EPV |
15 | 10 |
|
| 11 | +1. Clone your fork of this repository. |
| 12 | +2. Install composer dependencies: |
| 13 | + ```sh |
16 | 14 | $ php composer.phar install |
| 15 | + ``` |
| 16 | +3. Run EPV on a phpBB extension from the CLI: |
| 17 | + ```sh |
| 18 | + # Run EPV on a Git repository (at any repository hosting site) |
| 19 | + php src/EPV.php run --git="https://github.com/repo-org/repo-name.git" |
17 | 20 |
|
18 | | -1. You can run EPV on three different methods from the CLI: |
19 | | - * php src/EPV.php run --git="GIT_REPO" |
20 | | - * php src/EPV.php run --github="GITHUB_NAME" |
21 | | - * php src/EPV.php run --dir="LOCAL DIRECTORY" |
22 | | -1. You can use the --debug option to get some debug information. |
23 | | -1. You can also use EPV from soon [phpBB.com](https://www.phpbb.com/extensions/epv/) |
24 | | -1. Titania will check when submitting to phpBB.com using EPV as well. |
| 21 | + # Run EPV on a GitHub repository |
| 22 | + php src/EPV.php run --github="repo-org/repo-name" |
25 | 23 |
|
26 | | -License |
27 | | -------- |
28 | | -[GNU GPL v2](http://opensource.org/licenses/gpl-2.0) |
| 24 | + # Run EPV on a local directory |
| 25 | + php src/EPV.php run --dir="/path/to/extension" |
| 26 | + ``` |
29 | 27 |
|
30 | | -By contributing you agree to assign copyright of your code to phpBB Limited. |
| 28 | +> The `--branch` option can target a specific branch of a repository. |
| 29 | +> |
| 30 | +> The `--debug` option will output additional debugging information. |
31 | 31 |
|
32 | | -See `LICENSE` for the full license. |
| 32 | +You can also use EPV online at [phpBB.com](https://www.phpbb.com/extensions/epv/) |
33 | 33 |
|
34 | | -Maintenance and contributing |
35 | | ----------------------------- |
| 34 | +phpBB's Customisation Database (Titania) will run EPV on any submissions at phpBB.com as well. |
| 35 | +
|
| 36 | +## Maintenance and contributing |
36 | 37 |
|
37 | 38 | To contribute fork the repo, make your changes in a feature branch and send a pull request. |
38 | 39 |
|
39 | 40 | The site is maintained by the [phpBB Extensions Team](https://www.phpbb.com/community/memberlist.php?mode=group&g=7331) |
40 | 41 |
|
41 | 42 | Should you wish to report a bug report it at [Issue tracker](https://github.com/phpbb/epv/issues) |
| 43 | +
|
| 44 | +## License |
| 45 | +[GNU General Public License v2](https://opensource.org/licenses/GPL-2.0) |
| 46 | +
|
| 47 | +By contributing you agree to assign copyright of your code to phpBB Limited. |
| 48 | +
|
| 49 | +See `LICENSE` for the full license. |
0 commit comments