Skip to content

Commit 2ef49b3

Browse files
Update README to provide a better explanation of setting up (#56)
* Update README to provide a better explanation of setting up * Consolidate installation execution steps
1 parent 5bde32b commit 2ef49b3

File tree

3 files changed

+40
-17
lines changed

3 files changed

+40
-17
lines changed

.readme-partials/DEVELOPMENT.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
Every subfolder is a proper clone of the corresponding GitHub repository. This means that you can create new branches, make your changes, commit to the new branch and then submit as pull-request, all from within these folders.
22

3-
As the folders are also symlinked into the Composer `vendor` folder, you will always have the latest changes available when running WP-CLI through the `vendor/bin/wp` executable.
3+
Unless you have commit access to the repository, you'll need to fork the repository in order to push your feature branch. [GitHub's CLI](https://github.com/cli/cli) is pretty helpful for this:
4+
5+
```bash
6+
cd core-command
7+
gh repo fork
8+
```
49

10+
As the folders are also symlinked into the Composer `vendor` folder, you will always have the latest changes available when running WP-CLI through the `vendor/bin/wp` executable.

.readme-partials/INSTALLATION.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1-
Clone this repository onto your hard drive and then use Composer to install all dependencies:
1+
If you normally use WP-CLI on your web host or via Brew, you're most likely using the Phar executable (`wp-cli.phar`). This Phar executable file is the "built", singular version of WP-CLI. It is compiled from a couple dozen repositories in the WP-CLI GitHub organization.
22

3-
```
4-
git clone https://github.com/wp-cli/wp-cli-dev
5-
cd wp-cli-dev
6-
composer install
7-
```
8-
9-
This will:
3+
In order to make code changes to WP-CLI, you'll need to set up this `wp-cli-dev` development environment on your local machine. The setup process will:
104

115
1. Clone all relevant packages from the `wp-cli` GitHub organization into the `wp-cli-dev` folder, and
126
2. Install all Composer dependencies for a complete `wp-cli-bundle` setup, while symlinking all of the previously cloned packages into the Composer `vendor` folder.
137
3. Symlink all folder in `vendor` into corresponding `vendor` folders in each repository, thus making the centralized functionality based on Composer available in each repository subfolder.
8+
9+
Before you can proceed further, you'll need to make sure you have [Composer](https://getcomposer.org/), PHP, and a functioning MySQL or MariaDB server on your local machine.
10+
11+
Once the prequisites are met, clone the GitHub repository and run the installation process:
12+
13+
```bash
14+
git clone https://github.com/wp-cli/wp-cli-dev wp-cli-dev
15+
cd wp-cli-dev
16+
composer install
17+
composer prepare-tests
18+
```

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,36 @@ Quick links: [Installation](#installation) | [Development](#development) | [Usin
1111

1212
## Installation
1313

14-
Clone this repository onto your hard drive and then use Composer to install all dependencies:
14+
If you normally use WP-CLI on your web host or via Brew, you're most likely using the Phar executable (`wp-cli.phar`). This Phar executable file is the "built", singular version of WP-CLI. It is compiled from a couple dozen repositories in the WP-CLI GitHub organization.
1515

16-
```
17-
git clone https://github.com/wp-cli/wp-cli-dev
18-
cd wp-cli-dev
19-
composer install
20-
```
21-
22-
This will:
16+
In order to make code changes to WP-CLI, you'll need to set up this `wp-cli-dev` development environment on your local machine. The setup process will:
2317

2418
1. Clone all relevant packages from the `wp-cli` GitHub organization into the `wp-cli-dev` folder, and
2519
2. Install all Composer dependencies for a complete `wp-cli-bundle` setup, while symlinking all of the previously cloned packages into the Composer `vendor` folder.
2620
3. Symlink all folder in `vendor` into corresponding `vendor` folders in each repository, thus making the centralized functionality based on Composer available in each repository subfolder.
2721

22+
Before you can proceed further, you'll need to make sure you have [Composer](https://getcomposer.org/), PHP, and a functioning MySQL or MariaDB server on your local machine.
23+
24+
Once the prequisites are met, clone the GitHub repository and run the installation process:
25+
26+
```bash
27+
git clone https://github.com/wp-cli/wp-cli-dev wp-cli-dev
28+
cd wp-cli-dev
29+
composer install
30+
composer prepare-tests
31+
```
32+
2833
## Development
2934

3035
Every subfolder is a proper clone of the corresponding GitHub repository. This means that you can create new branches, make your changes, commit to the new branch and then submit as pull-request, all from within these folders.
3136

37+
Unless you have commit access to the repository, you'll need to fork the repository in order to push your feature branch. [GitHub's CLI](https://github.com/cli/cli) is pretty helpful for this:
38+
39+
```bash
40+
cd core-command
41+
gh repo fork
42+
```
43+
3244
As the folders are also symlinked into the Composer `vendor` folder, you will always have the latest changes available when running WP-CLI through the `vendor/bin/wp` executable.
3345

3446
## Using

0 commit comments

Comments
 (0)