From 06605429d32a712c503bbd8848a946b79878467c Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 3 Sep 2014 09:26:49 -0400 Subject: [PATCH] describe how to install the Boilerplate. Updating the `README` to describe how to install the Boilerplate. Fixes #213 --- ChangeLog.md | 1 + README.md | 16 +++++++++++++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/ChangeLog.md b/ChangeLog.md index cfab9e8..8e111ab 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,3 +1,4 @@ # ChangeLog +* (3 September 2014). Updating the `README` to describe how to install the Boilerplate. * (1 September 2014). Initial Release diff --git a/README.md b/README.md index a8971ff..9169bde 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,25 @@ The WordPress Plugin Boilerplate includes the following files: ## Installation -1. Copy the `plugin-name` directory into your `wp-content/plugins` directory. +The Boilerplate can be installed in one of two ways both of which are documented below. Note that because of its directory structure, the Boilerplate cannot be installed “as-is.” + +Instead, the options are: + +### Copying a Directory + +1. Copy the `trunk` directory into your `wp-content/plugins` directory. You may wish to rename this to something else. 2. In the WordPress dashboard, navigation to the *Plugins* page Locate the menu item that reads “The WordPress Plugin Boilerplate.” 3. Click on *Activate.* +### Create a Symbolic Link + +1. Copy the `WordPress-Plugin-Boilerplate` directory into your `wp-content/plugins` directory. +2. Create a symbolic link between the `trunk` directory and the plugin. For example: `ln -s plugin-name/trunk /path/to/wordpress/wp-content/plugins/plugin-name` +3. In the WordPress dashboard, navigation to the *Plugins* page +Locate the menu item that reads “The WordPress Plugin Boilerplate.” +4. Click on *Activate.* + Note that this will activate the source code of the Boilerplate, but because the Boilerplate has no real functionality so no menu items, meta boxes, or custom post types will be added. Examples are slated to be added to the [Boilerplate’s website](http://wppb.io) as the site continues to grow.