README.md

# Visit the [WEC-Sim website](http://wec-sim.github.io/WEC-Sim) for more information.

## WEC-Sim Repository

* **Docs**: WEC-Sim documentation. Refer to [these instructions](https://github.com/WEC-Sim/WEC-Sim/tree/dev/docs/README.md) to compile the [WEC-Sim Website](http://wec-sim.github.io/WEC-Sim/dev/index.html). 
* **Examples**: WEC-Sim model examples
* **Source**: WEC-Sim source code
* **Tests**: WEC-Sim tests run by Jenkins Server for [MATLAB Continuous Integration](https://www.mathworks.com/solutions/continuous-integration.html)
* **Tutorials**: [WEC-Sim Tutorials](http://wec-sim.github.io/WEC-Sim/master/index.html)

Refer to the [WEC-Sim Applications](https://github.com/WEC-Sim/WEC-Sim_Applications)
repository for more applications of the WEC-Sim code.

## Source Code Management

A stable version of WEC-Sim is maintained on the [master branch](https://github.com/WEC-Sim/WEC-Sim) of WEC-Sim, and stable [releases](https://github.com/WEC-Sim/WEC-Sim/releases) of WEC-Sim are tagged on GitHub. 
WEC-Sim development is performed on the dev branch using a [forking workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow). 
New WEC-Sim features are developed on forks of the WEC-Sim repository, and [pull-requests](https://github.com/WEC-Sim/WEC-Sim/pulls) are submitted to merge new features from a development fork into the main WEC-Sim repository. 
When submitting a pull-request for a new WEC-Sim feature, pull-requests should be submitted to the [dev branch](https://github.com/WEC-Sim/WEC-Sim/tree/dev). 
The only exception to this workflow is for bug fixes, pull-request for bug fixes should be should submitted to the [master branch](https://github.com/WEC-Sim/WEC-Sim).