inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-22 20:03:53 +02:00
Code Issues Releases Wiki Activity

describe how to install the Boilerplate.

Browse source 
Updating the `README` to describe how to install the Boilerplate.

Fixes #213
This commit is contained in:
Tom McFarlin 2014-09-03 09:26:49 -04:00
parent c8bd2e38af
commit 06605429d3
2 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
ChangeLog.md
View file

@ -1,3 +1,4 @@
# ChangeLog # ChangeLog
* (3 September 2014). Updating the `README` to describe how to install the Boilerplate.
* (1 September 2014). Initial Release * (1 September 2014). Initial Release

16
README.md
View file

@ -20,11 +20,25 @@ The WordPress Plugin Boilerplate includes the following files:
## Installation ## 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 2. In the WordPress dashboard, navigation to the *Plugins* page
Locate the menu item that reads “The WordPress Plugin Boilerplate.” Locate the menu item that reads “The WordPress Plugin Boilerplate.”
3. Click on *Activate.* 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. 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. Examples are slated to be added to the [Boilerplate’s website](http://wppb.io) as the site continues to grow.