Skip to content

Commit

Permalink
Further updates to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
allebb committed Jan 23, 2015
1 parent d73354e commit 3f27ee0
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
# PSR auto-formatting for NetBeans
# PSR1/PSR2 auto-formatting for NetBeans IDE

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.
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.

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.

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.

## Requirements

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

## License

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

## Support

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).
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).

## Installation

TBC

## Preparing the source code for 'import'

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.
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 comments on commit 3f27ee0

Please sign in to comment.