# Yarn Spinner Documentation

## Yarn Documentation

Documentation for Yarn is under active development. Please submit any suggestions you may have.

YarnSpinner documentation is generated automatically by the [Doxygen](http://www.doxygen.org) system.

## Building Yarnspinner
Yarnspinner is automatically built by Travis Continual Integration system. For information on how to build it yourself, please refer to the [Building](Building.md) document.

## Using Yarnspinner
For information on how to write stories for Yarnspinner, refer to the [Usage](Usage.md) document.

## Using Unity
At this point in time, only examples for the Unity game engine are available. We hope to include a more generic example in the future.  Please refer to the [Unity](Unity.md) document for more information.

### Tips during Unity install

### Windows

Find the temp folder the installer has executed from and back it up before it completes installing.

### Mac

(This space left intentionally blank)

### Linux

As Unity for Linux is currently not available in final release, we are not actively pursuing this platform however we are very enthusastic about this future prospect.

## Extending Tarnspinner
For information on how to extend Yarnspinner's functionality, please refer to the [Extending Yarnspinner](Extending.md) document.


# Yarn Spinner Documentation

## Yarn Documentation

Documentation for Yarn is under active development. Please submit any suggestions you may have.

YarnSpinner documentation is generated automatically by the [Doxygen](http://www.doxygen.org) system.

## Building Yarnspinner
Yarnspinner is automatically built by Travis Continual Integration system. For information on how to build it yourself, please refer to the [Building](Building.md) document.

## Using Yarnspinner
For information on how to write stories for Yarnspinner, refer to the [Usage](Usage.md) document.

## Using Unity
At this point in time, only examples for the Unity game engine are available. We hope to include a more generic example in the future.  Please refer to the [Unity](Unity.md) document for more information.

### Tips during Unity install

### Windows

Find the temp folder the installer has executed from and back it up before it completes installing.

### Mac

(This space left intentionally blank)

### Linux

As Unity for Linux is currently not available in final release, we are not actively pursuing this platform however we are very enthusastic about this future prospect. However, we encourge Linux users to test our code using the [Monodevelop FlatPak](http://www.monodevelop.com/download/linux/). Whilst FlatPak is designed to be Linux agnostic, we are currently utilising Gnome3 on Debian Stretch for desktop development purposes. 

## Extending Tarnspinner
For information on how to extend Yarnspinner's functionality, please refer to the [Extending Yarnspinner](Extending.md) document.


Clarify Linux desktop distuation to Gnome3 Debian-Stretch
Clarify Linux desktop distuation to Gnome3 Debian-Stretch
