inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-05-03 11:53:16 +03:00
Code Issues Releases Wiki Activity

Adding instructions for Windows symlinks

Browse source 
Fixes #213
This commit is contained in:
Tom McFarlin 2014-09-04 09:44:54 -04:00
parent 06605429d3
commit 16c93f8548
2 changed files with 17 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
ChangeLog.md
View file

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

12
README.md
View file

@ -31,7 +31,9 @@ Instead, the options are:
Locate the menu item that reads “The WordPress Plugin Boilerplate.”
3. Click on *Activate.*
### Create a Symbolic Link
### Creating a Symbolic Link
#### On Linux or OS X
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`
@ -39,6 +41,14 @@ Locate the menu item that reads “The WordPress Plugin Boilerplate.”
Locate the menu item that reads “The WordPress Plugin Boilerplate.”
4. Click on *Activate.*
#### On Windows
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: `mklink /J path\to\wp-content\plugins \path\to\WordPress-Plugin-Boilerplate\trunk\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.