# Open to improvements

Feel free to submit pull-requests or suggestions via issues to improve this process, any document, or any of the code. Your help is appreciated.


# Guidelines

- Try to follow the code style in the script you're editing or surrounding scripts.
- Use [Biscotto](https://github.com/gjtorikian/biscotto) style comments on classes, methods, etc.
- Take care that this module supports Windows, Mac, and Linux, NW.js and Electron, with or without Squirrel (auto-updating).
- Be nice.


# Setup

1. `npm install -g gulp`
2. `npm install`
3. Install the [EditorConfig](http://editorconfig.org) plugin for your IDE / text-editor.


# Compilation

1. `gulp` or `npm run compile`


# Running tests

(No need to compile first)

1. `npm test`
