Skip to content

Commit 3f27ee0

Browse files
committed
Further updates to the README
1 parent d73354e commit 3f27ee0

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
1-
# PSR auto-formatting for NetBeans
1+
# PSR1/PSR2 auto-formatting for NetBeans IDE
22

3-
Provides import-able configuration settings for PSR1/PSR2 standards. Although NetBeans does not provide automatic formatting support for all of the PSR1 and PSR2 standards (eg. refactoring class and method names), where possible I have implemented the new line, braces positioning, spaced tabs etc. When using the ```Source > Format``` function in NetBeans the PHP code will automatically be formatted to match PSR1/2 syntax format.
3+
This repository provides source code auto-formatting settings for PHP [PSR1](http://www.php-fig.org/psr/psr-1/) and [PSR2](http://www.php-fig.org/psr/psr-2/) standards.
4+
5+
Although [NetBeans](https://netbeans.org/) does not provide automatic formatting support for all of the PSR1 and PSR2 'rules' (eg. refactoring class and method name case) I have done my best to implement as much as possible.
6+
7+
The result of using this configuration is, once imported you can then use the ```Source > Format``` function (``ALT``+``SHIFT``+``F`` on Windows and Linux) or (``ALT``+``F`` on Mac) in NetBeans the PHP code will automatically be formatted to match PSR1/PSR2 syntax format.
48

59
## Requirements
610

711
* [NetBeans](https://netbeans.org/) (Tested and developed on v8.0.2 but should work fine on other versions too!)
812

913
## License
1014

11-
These configuration settings files are released under the [MIT license](LICENSE).
15+
All things have a license I guess, so keeping it plain and simple, these files are released under the [MIT license](LICENSE).
1216

1317
## Support
1418

15-
I am happy to provide support via. my personal email address, so if you need a hand drop me an email at: [mailto:ballen@bobbyallen.me](ballen@bobbyallen.me).
19+
I am happy to provide support via. my personal email address, so if you need a hand or want to give me some feedback feel free to drop me an email at: [ballen@bobbyallen.me](mailto:ballen@bobbyallen.me).
1620

1721
## Installation
1822

1923
TBC
2024

2125
## Preparing the source code for 'import'
2226

23-
In order to import the settings into NetBeans, compress the root directory of the ```src``` directory into a .ZIP file of which can then be used to import into NetBeans as shown below in the installation guide.
27+
In order to import the settings into NetBeans, compress the root directory of the ```src``` directory into a **zip file** of which can then be used to import into NetBeans as shown below in the installation guide.

0 commit comments

Comments
 (0)