Skip to content

Commit c1748f0

Browse files
committed
Update README.md content for file restructure
1 parent 6966a76 commit c1748f0

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,30 @@ This installation script automatically sets up a development Docker server with
77
_Note: [DDEV](https://ddev.com/) needs to be installed in order for the installation script to work._
88

99
1. Clone this [repo](https://github.com/jacobcassidy/ddev-wp-setup-script) to your (preferably empty) project's root directory with the command: **`git clone [email protected]:jacobcassidy/ddev-wp-setup-script.git`**
10-
2. Customize the configuration settings in: _ddev-wp-setup-script/config.sh_
10+
2. Customize the script's configuration settings at: _ddev-wp-setup-script/settings.sh_
1111
3. Run the installation script in you project's root directory with the command: **`ddev-wp-setup-script/install.sh`**
1212
4. Delete the _ddev-wp-setup-script_ directory after successfully running the installation script
1313

1414
## Features
1515

16+
> [!NOTE]
17+
> The optional features can be turned on/off in the `settings.sh` file.
18+
1619
This script automatically sets up the following:
1720

1821
- Configures and starts the [DDEV](https://ddev.com/) Docker containers with a WordPress development server.
1922
- Installs a clean WordPress site with the default pages, posts, comments, plugins, themes, welcome panel and dashboard widgets removed (with the exception of the latest official default theme as a fallback).
20-
- Downloads, installs, and activates the [CassidyWP Starter Block Theme](https://github.com/jacobcassidy/cassidywp-starter-block-theme).
21-
- Installs the [All-in-One WP Migration plugin](https://wordpress.org/plugins/all-in-one-wp-migration/).
22-
- Installs the [All-in-One WP Migration Unlimited Extension plugin](https://servmask.com/products/unlimited-extension).
23-
- _Note: this plugin is not free and is sourced from your local machine since it's unavailable through the official WP plugin directory. If you don't have this plugin, you can turn the installation off in the `config.sh` file by setting `INSTALL_LOCAL_AIOMUE_PLUGIN` to false._
24-
- Installs the [Query Monitor plugin](https://wordpress.org/plugins/query-monitor/).
25-
- Installs the files needed to connect the DDEV Docker containers with the [Spatie Ray](https://myray.app/) desktop app (used for simple debugging when Xdebug is overkill).
26-
- Initializes a local project Git repo and adds a `.gitignore` file configured for WordPress.
27-
- Adds a VSCode Workspace `.vscode/settings.json` file to include formatting rules to match WordPress's official coding standards.
23+
- (Optional) Downloads, installs, and activates the [CassidyWP Starter Block Theme](https://github.com/jacobcassidy/cassidywp-starter-block-theme).
24+
- (Optional) Installs the [All-in-One WP Migration plugin](https://wordpress.org/plugins/all-in-one-wp-migration/).
25+
- (Optional) Installs the [All-in-One WP Migration Unlimited Extension plugin](https://servmask.com/products/unlimited-extension).
26+
- _The setup for this plugin is set to `false` by default since it's a paid plugin and is installed from your local machine. If you have this plugin, you can turn the installation on in the `settings.sh` file by changing `INSTALL_LOCAL_AIOMUE_PLUGIN` to `true` and updating the path to your zip file._
27+
- (Optional) Installs the [Query Monitor plugin](https://wordpress.org/plugins/query-monitor/).
28+
- (Optional) Installs the files needed to connect the DDEV Docker containers with the [Spatie Ray](https://myray.app/) desktop app (used for simple debugging when Xdebug is overkill).
29+
- (Optional) Initializes a local project Git repo and adds a `.gitignore` file configured for WordPress.
30+
31+
## Configuration files for development
32+
33+
Originally, this script contained development configuration files such as `prettier.config.js` and `eslint.config.js`. Those configuration files have been moved to their own repo at [wp-dev-config-files](https://github.com/jacobcassidy/wp-dev-config-files) and can be cloned from there.
2834

2935
## Found an Issue?
3036

0 commit comments

Comments
 (0)