Skip to content

Commit

Permalink
adding missing README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
giovannibedetti committed Mar 6, 2022
1 parent 6611a1f commit eb28989
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
[![openupm](https://img.shields.io/npm/v/com.csound.csoundunity?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.csound.csoundunity/)

# CsoundUnity #
#### Csound wrapper for the Unity game engine.
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

Please visit [homepage](http://rorywalsh.github.io/CsoundUnity/)

This simple wrapper is based on Richard Henninger's Csound6Net .NET wrapper.
If you wish to use the Csound API in a model that is idiomatic to .net please use his wrapper instead.
http://csound6net.codeplex.com (unfortunately the site is not reachable at the moment)

## New Version: 3.2.0 ##

Read the [CHANGELOG](https://github.com/rorywalsh/CsoundUnity/blob/master/CHANGELOG.md) for more details.

## How to import CsoundUnity ##

**From version 3.0 CsoundUnity is in the form of a Unity Package**. See the [Unity Manual](https://docs.unity3d.com/Manual/PackagesList.html) for more information.

You should use the **Unity Package Manager** to import the CsoundUnity package in your project.
To open the Package Manager in Unity, select **Window/PackageManager** from the top menu.

**If you have git installed**: press +, *Add package from git url...*, paste this url https://github.com/rorywalsh/CsoundUnity.git, and press Add.

**If you don’t have git**: Download the Source Code (zip or tar.gz) of the [Latest Release](https://github.com/rorywalsh/CsoundUnity/releases/latest) on your local disk, extract its content, press + in the Package Manager, *Add package from disk...*, and select the package.json inside the extracted folder.

## Documentation ##

[Here you can find the docs](https://github.com/rorywalsh/CsoundUnity/blob/master/Documentation~/index.md)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="http://www.giovannibedetti.com"><img src="https://avatars1.githubusercontent.com/u/1912983?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Giovanni Bedetti</b></sub></a><br /><a href="https://github.com/rorywalsh/CsoundUnity/commits?author=giovannibedetti" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/berntisak"><img src="https://avatars0.githubusercontent.com/u/9213871?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bernt Isak Wærstad</b></sub></a><br /><a href="https://github.com/rorywalsh/CsoundUnity/commits?author=berntisak" title="Code">💻</a></td>
<td align="center"><a href="http://bermondo.com"><img src="https://avatars1.githubusercontent.com/u/33271566?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Charles Berman</b></sub></a><br /><a href="https://github.com/rorywalsh/CsoundUnity/commits?author=ceberman" title="Code">💻</a></td>
<td align="center"><a href="http://www.hcenteno.net"><img src="https://avatars3.githubusercontent.com/u/4064498?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hector Centeno</b></sub></a><br /><a href="https://github.com/rorywalsh/CsoundUnity/commits?author=hectorC" title="Code">💻</a></td>
<td align="center"><a href="http://npatsiouras.wordpress.com/"><img src="https://avatars.githubusercontent.com/u/6648226?v=4?s=100" width="100px;" alt=""/><br /><sub><b>NPatch</b></sub></a><br /><a href="https://github.com/rorywalsh/CsoundUnity/commits?author=NPatch" title="Code">💻</a></td>
</tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 comments on commit eb28989

Please sign in to comment.