documentation.html

<p><title>PyAudioGame Documentation</title></p>

<h1>refferense links</h1>

<ul>
<li><a href="API/index.html">API</a></li>
<li><a href="basic/index.html">Basic Tutorials</a></li>
<li><a href="advanced/index.html">Advanced Developer Tutorial</a>
<br/></li>
</ul>

<h1>About</h1>

<p>PyAudioGame is a toolkit for writing audio games in python.
It is cross-platform and open-source.</p>

<h2>Getting started</h2>

<p>PyAudioGame is built for both newbie and advanced programmers in mind. 
If you're someone who has never seen python code, or code in general, take a look at <a href="basic/index.html">The newbie tutorial.</a>
If you are comfortable in python already and just wish to learn about how pyaudiogame is setup, head on over to <a href="index.html">the advanced tutorials</a> and see how some games are built.</p>

<h2>Installing</h2>

<p>There are two ways to run pyaudiogame:</p>

<ol>
<li>*in progress* Download the complete development environment and open up the pyaudiogame.bat file. navigate to your script and run python myscript.py and everything will be loaded.</li>
<li>Download the <a href="https://codeload.github.com/frastlin/PyAudioGame/zip/master">zipped package</a> from the
<a href="https://github.com/frastlin/PyAudioGame">GitHub page,</a>
open a command-line console and run python setup.py install.</li>
</ol>

<h2>Licence</h2>

<p>pyaudiogame is open-source and under the mit licence.
This means you can do what ever you wish with it!</p>

<h2>Support</h2>

<p>If you have problems, either post your question on our mailing list *under development* or post your question in the developer's room at <a href="http://forum.audiogames.net/viewforum.php?id=28">audiogames.net</a>
<br/>
If you have an idea for a feature or find a bug, please <a href="https://github.com/frastlin/PyAudioGame/issues">submit a git issue.</a></p>

<h2>development</h2>

<p>If you have a module or user interface you think other people should have, make sure it is free of bugs and submit it to the user repository with an extensive readme and documentation.
*under development*
If you would like to submit code to the core package, please clone your copy of the <a href="https://github.com/frastlin/PyAudioGame.git">master branch.</a>
*under development* Create your own branch and push it to be reviewed.</p>