checkstyle/README.md
# Geometrize Haxe Coding Standard
The bundled checkstyle configuration provides a coding standard for the Geometrize Haxe library.
## Setup
```
haxelib install checkstyle
```
## Usage
Run Checkstyle from your console:
```
haxelib run checkstyle -s ../geometrize -c ../checkstyle_config.json
```
## Tips
* Run Checkstyle as a post-build step or as a compile-on-save option. This makes adhering to the coding standard less demanding.