Skip to content

Commit e7f1ef5

Browse files
committed
Fix README.md
1 parent 7ea50ee commit e7f1ef5

1 file changed

Lines changed: 47 additions & 29 deletions

File tree

README.md

Lines changed: 47 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ This is NetBeans plugin for WordPress.
44

55
## How to enable
66

7-
`enabled` option is unchecked as default. Please check it on `project properties > Frameworks > WordPress`
7+
`enabled` option is unchecked by default. Please check it on `project properties > Frameworks > WordPress`
88

9-
## Environment
10-
- NetBeans 8.0+
9+
## Requirements
10+
11+
- NetBeans 8.2+
1112
- WordPress 3.5+
1213

1314
## Features
15+
1416
- badge icon
1517
- important files
1618
- create new WordPress project
@@ -34,38 +36,46 @@ This is NetBeans plugin for WordPress.
3436
- .htaccess (only the root directory)
3537

3638
### Create New WordPress Project
37-
You can create a new WordPress project with Wizard.
3839

39-
1. set Tools > Options > PHP > WordPress > download url(e.g. http://wordpress.org/latest.zip) or local file path(e.g. /path/to/wordpress.zip)
40-
2. check New Project > PHP > PHP Application > ... > Framework > WordPress PHP Web Blog/CMS
41-
3. select options (url / local file / wp-cli)
42-
4. finish
40+
You can create a new WordPress project via a wizard.
41+
42+
1. Set Tools > Options > PHP > WordPress > download url(e.g. http://wordpress.org/latest.zip) or local file path(e.g. /path/to/wordpress.zip)
43+
2. Click File > New Project
44+
3. Check PHP > PHP Application > ... > Framework > WordPress PHP Web Blog/CMS
45+
4. Select options (url / local file / wp-cli)
46+
5. Set wp-config options
47+
6. Click the Finish button
4348

4449
### Custome Content Name
4550

46-
If you want to use custom content name(default is `wp-content`), please set your content name to the project properties.
51+
If you want to use a custom content name (default value is `wp-content`), please set your content name to the project properties.
4752
(project properties > Framework > WordPress)
4853

4954
#### options
55+
5056
- Set format to project : set format option to project.properties
5157
- create wp-config.php : copy from wp-config-sample.php
5258

5359
### Code Templates
60+
5461
- wpph : wordpress plugin header
5562
- wpgpl : wordpress license comment
5663

5764
e.g. please type wpph [Tab]
5865

5966
### Zip Compress Action
67+
6068
You can compress specified pluign or theme directory as Zip file to the same hierarchy.
6169
Right-click active plugin or theme node > Zip compress
6270

6371
### Template Files
72+
6473
You can create a pluign file and readme file with new file wizard.
6574

66-
Right-click directory > New > Others > WordPress > (WordPress Plugin | WordPress Plugin Readme)
75+
Right-click a directory > New > Others > WordPress > (WordPress Plugin | WordPress Plugin Readme)
6776

6877
### Code Completion for Filter and Action
78+
6979
This feature is available the followings:
7080
- add_filter, remove_filter
7181
- add_acttion, remove_action
@@ -79,43 +89,50 @@ add_filter('the_content', 'w[Ctrl + Space]'); // e.g. start with 'w'
7989
```
8090

8191
### Display And Change Debug Status
92+
8293
WP_DEBUG value(wp-config.php) is displayed on bottom-right of IDE.
8394
If you click there, you can change WP_DEBUG value.
8495
WordPress version number is also displayed.
8596

8697
### Create New Theme Action
87-
Right-click Project > WordPress > Create Theme
98+
99+
Right-click a WordPress project node > WordPress > Create Theme
88100

89101
#### Minimum Theme
90102

91-
Just create a style.css and an empty index.php.
103+
Just create a style.css and an empty index.php to the directory which you named.
92104

93105
#### Underscores
94-
Create theme from [Underscores | A Starter Theme for WordPress](http://underscores.me/). Underscores is awesome!
106+
107+
Create a theme from [Underscores | A Starter Theme for WordPress](http://underscores.me/). Underscores is awesome!
95108
This plugin uses [Automattic/_s · GitHub](https://github.com/automattic/_s).
96109

97110
**Please note that license of created theme is GPLv2**
98111

99112
#### Barebones
100-
Create theme form [welcomebrand/Barebones · GitHub](https://github.com/welcomebrand/Barebones).
113+
114+
Create a theme form [welcomebrand/Barebones · GitHub](https://github.com/welcomebrand/Barebones).
101115

102116
### Create New Child Theme Action
103-
Right-click Project > WordPress > Create Child Theme
117+
118+
Right-click a WordPress project node > WordPress > Create Child Theme
104119

105120
- Create a new directory for child theme
106121
- Add style.css for child theme
107122

108123
### Create New Plugin Action
124+
109125
Right-click Project > WordPress > Create Plugin
110126

111-
This is very simple feature.
112-
- input plugin name(plugin_name)
113-
- create new plugin directory(plugins/plugin_name)
114-
- add main plugin file (plugins/plugin_name/plugin_name.php)
115-
- add readme file (plugins/plugin_name/readme.txt)
127+
This is very simple feature. If you input a plugin name (plugin_name)...
128+
129+
- Create a new plugin directory (plugins/plugin_name)
130+
- Add a main plugin file there (plugins/plugin_name/plugin_name.php)
131+
- Add a readme file there (plugins/plugin_name/readme.txt)
116132

117133
### Hyperlink Navigation
118-
This feature is available the followings:
134+
135+
This feature is available on the parameters of following functions:
119136
- add_filter, remove_filter
120137
- add_action, remove_action
121138

@@ -124,31 +141,31 @@ Then caret position go to function. (first parameter is available when there are
124141

125142
### Run Command
126143

127-
We can run wp-cli commands. *Please notice that this action needs so much time to get command list at first time.*
144+
You can run wp-cli commands. *Please note that this action needs so much time to get command list at first time.*
128145

129146
1. Set wp-cli script path to Options. Tools > Options > PHP > WordPress
130-
2. Select WordPress Project node
131-
3. Right-click > WordPress > RunCommand...
147+
2. Right-click a WordPress project node > WordPress > RunCommand...
132148

133149
#### wp-cli
134150

135-
Please see the followings:
151+
Please see the following links:
136152

137153
- https://github.com/wp-cli/wp-cli
138154
- http://wp-cli.org/
139155

140156
### Upgrade Notification
141157

142-
Check whether new versions (for core, plugin and theme) are available when WordPress project is opened.
143-
Furthermore, we can upgrade(run core update, core update-db, e.t.c.) WordPress with notification window if we are setting wp-cli.
158+
Check whether new versions (for core, plugin and theme) are available when a WordPress project is opened.
159+
Furthermore, you can upgrade(run core update, core update-db, e.t.c.) WordPress from a notification window if we are setting wp-cli.
144160

145161
If you don't want to check that, please uncheck `Check new version when project is opened` at Options.
146162

147163
### Create a .htaccess file for permalink
148164

149-
Right-click project node > WordPress > Create .htaccesss for permalink
165+
Right-click a WordPress project node > WordPress > Create .htaccesss for permalink
150166

151167
#### Note
168+
152169
.htaccess file for permalink can be also created with template.
153170

154171
## Version Number
@@ -166,9 +183,10 @@ Available on [Plugin Portal](http://plugins.netbeans.org/plugin/46542/php-wordpr
166183

167184
If development version exists, it will be available in the same archive as stable version.
168185

169-
### Archive
186+
### Downloads
170187

171188
[github releases](https://github.com/junichi11/netbeans-wordpress-plugin/releases)
172189

173190
## License
191+
174192
[Common Development and Distribution License (CDDL) v1.0 and GNU General Public License (GPL) v2](http://netbeans.org/cddl-gplv2.html)

0 commit comments

Comments
 (0)