From 03bb1a99a92fa4413335a70d11f8dc1d6e965089 Mon Sep 17 00:00:00 2001 From: Piper Haywood Date: Thu, 7 Nov 2019 14:05:43 +0000 Subject: [PATCH] Update readme instructions --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c24c86d..43077f7 100644 --- a/README.md +++ b/README.md @@ -36,4 +36,6 @@ The shortcode `[notebooklist]` displays a chronological list of posts. ## Development -I prefer to keep this theme separate from my WordPress installation when working on this locally. To do this, set up a WordPress site locally using this [multi-environment `wp-config.php` gist](https://gist.github.com/piperhaywood/2a7217964335e22574784153eab1d38b) if useful. Once you’ve set up the site, symlink the theme folder `/notebook-ph` within this repo in to your WP site’s `/wp-content/themes` directory. Back in the root of this repo, run `npm i` to install dependencies. Run `gulp` to build the theme or `gulp dev` for development. The command `gulp dev` will compile the files and then use BrowserSync for live reloading. To set a BrowserSync proxy other than the default `localhost:8888`, run `gulp dev --proxy custom-proxy` (replace `custom-proxy`). +To set this repo up, install WordPress in a separate directory using this [multi-environment `wp-config.php` gist](https://gist.github.com/piperhaywood/2a7217964335e22574784153eab1d38b) if useful, then symlink the theme folder `/notebook-ph` within this repo in to your WP site’s `/wp-content/themes` directory. You can do this with multiple WordPress installations, which can be useful for testing styles against different content. I use this with one WordPress installation that reflects [piperhaywood.com](https://piperhaywood.com) and another that uses WordPress’s theme testing database. + +Once you have the WordPress installation set up and the theme symlinked, run `npm i` from the root of this repo to install dependencies. Run `gulp` to build the theme or `gulp dev` for development. The command `gulp dev` will compile the files and then use BrowserSync for live reloading. To set a BrowserSync proxy other than the default `localhost:8888`, run `gulp dev --proxy custom-proxy` (replace `custom-proxy`).