Skip to content

Commit bf3497b

Browse files
author
Anthony Burchell
committed
adjusts readme
1 parent 89ae709 commit bf3497b

File tree

1 file changed

+21
-25
lines changed

1 file changed

+21
-25
lines changed

README.md

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,63 @@
11
# PHP Compatibility Checker
22

3-
The WP Engine PHP Compatibility Checker can be used by any WordPress website on any web host to check PHP version compatibility.
3+
An easy way to check your site for PHP Compatibility.
44

55
## Setup Development Environment
66

77
Before starting your workstation will need the following:
88

99
* [Docker](https://www.docker.com/)
10-
* [Lando](https://lando.dev/)
1110

1211
1. Clone the repository
1312

14-
`[email protected]:wpengine/wpe-php-compat.git`
13+
`[email protected]:wpengine/phpcompat.git`
1514

16-
2. Start Lando
15+
2. Setup WP-Env
1716

1817
```bash
19-
cd wpe-php-compat
20-
make start
18+
make setup && make start
2119
```
2220

23-
When finished, Lando will give you the local URL of your site. You can finish the WordPress setup there. WooCommerce will be configured with enough sample data to get you started.
21+
When finished, a local WordPress will be configured at http://localhost:8888/wp-admin.
2422

2523
WordPress Credentials:
2624

27-
__URL:__ _https://wpe-php-compat.lndo.site/wp-admin_
25+
__URL:__ _http://localhost:8888/wp-admin_
2826

2927
__Admin User:__ _admin_
3028

31-
__Admin Password:__ _password_
29+
__Admin Password:__ _password
3230

33-
## Using Xdebug
34-
35-
Xdebug 3 released a [number of changes](https://xdebug.org/docs/upgrade_guide) that affect the way Xdebug works. Namely, it no longer listens on every request and requires a "trigger" to enable the connection. Use one of the following plugins to enable the trigger on your machine:
36-
37-
38-
* [Xdebug Helper for Firefox](https://addons.mozilla.org/en-GB/firefox/addon/xdebug-helper-for-firefox/) ([source](https://github.com/BrianGilbert/xdebug-helper-for-firefox)).
39-
* [Xdebug Helper for Chrome](https://chrome.google.com/extensions/detail/eadndfjplgieldjbigjakmdgkmoaaaoc) ([source](https://github.com/mac-cain13/xdebug-helper-for-chrome)).
40-
* [XDebugToggle for Safari](https://apps.apple.com/app/safari-xdebug-toggle/id1437227804?mt=12) ([source](https://github.com/kampfq/SafariXDebugToggle)).
31+
After you have logged in, go to http://localhost:8888/wp-admin/admin.php?page=fakerpress and generate some dummy content for the block to render.
4132

33+
If anything goes wrong and you suspect your local is frozen, you can always `make choose-violence` to rebuild the local environment and containers. Hopefully you never have to choose violence. :)
4234

4335
## Build and Testing
4436

45-
The only current build asset is the .pot file for internationalization. Build it with the following:
46-
4737
```bash
4838
make build
4939
```
5040

5141
Note, assets will also build during the install phase.
5242

43+
You can run all testing (all lints and unit tests) together with the following:
44+
45+
```bash
46+
make test
47+
```
48+
5349
The project uses the [Brain Monkey](https://brain-wp.github.io/BrainMonkey/) library for unit testing. Once setup run the following for unit tests:
5450

5551
```bash
5652
make test-unit
5753
```
5854

55+
The project uses the WordPress e2e tests. Run the following for e2e tests:
56+
57+
```bash
58+
make test-e2e
59+
```
60+
5961
We also use [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) with [WordPress Coding Standards](https://github.com/WordPress/WordPress-Coding-Standards) and [JSHint](http://jshint.com/) with [WordPress' JS Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/javascript/#installing-and-running-jshint). Linting will automagically be setup for you if you use [Visual Studio Code](https://code.visualstudio.com/). If you want to run it manually use the following:
6062

6163
```bash
@@ -72,12 +74,6 @@ make test-lint-php
7274
make test-lint-javascript
7375
```
7476

75-
You can run all testing (all lints and unit tests) together with the following:
76-
77-
```bash
78-
make test
79-
```
80-
8177
Screw something up? You can reset your environment with the following. It will stop the environment and cleanup and the build files as well as anything downloaded.
8278

8379
```bash

0 commit comments

Comments
 (0)