Skip to content

Commit

Permalink
Updating README file in prep for v1.0.2 release (supporting Netbeans …
Browse files Browse the repository at this point in the history
…8.2)
  • Loading branch information
allebb committed Sep 21, 2016
1 parent fec8adb commit 1bedd10
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The result of using this configuration is, once imported you can then use the ``

## Requirements

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

## License

Expand All @@ -20,14 +20,19 @@ I am happy to provide support via. my personal email address, so if you need a h

## Installation

* Download the [latest release](https://github.com/bobsta63/netbeans-psr-formatting/releases) (specifically the __ZIP__ version) to your machine.
* Download the [latest release](https://github.com/bobsta63/netbeans-psr-formatting/releases) (specifically the __ZIP__ version) to your machine (If you're using Netbeans 8.1 or below see the notes below about a bug and a provided workaround version).
* Open up the NetBeans IDE on your computer
* From the top menu, click on ```Tools``` and then from the menu that appears click ```Options```
* When the **Options** window appears click on the ```Import``` button at the bottom left.
* When the **Import** window appears click on the ```Browse``` button and select the downloaded zip archive that you downloaded in the first step.
* Under the ```Select options to import:```, check the ```All``` check box and then click ```Ok``` and then ```Apply```.
* You should then be prompted to restart the IDE, restart and enjoy your new auto-formatting skills ;)

## Using NetBeans 8.1 (and lower)?

There is an issue in Netbeans versions 8.1 (and lower) in which the ``namespace`` new-line configuration does not work (a bug) of which has since been
fixed in Netbeans 8.2. As a workaround however, [release v1.0.1](https://github.com/bobsta63/netbeans-psr-formatting/releases/tag/v1.0.1) uses a single blank line to split the ``namespace`` from the first line of which is recommended to use.

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

0 comments on commit 1bedd10

Please sign in to comment.