README.md

StepMania
=========

StepMania is an advanced cross-platform rhythm game for home and arcade use.

Advanced cross-platform rhythm game for home and arcade use.

##Installing from Setup/Installer##

For those that do not wish to compile the game on their own and use a binary right away, be aware of the following issues:

* Windows users are expected to have installed the [Microsoft Visual C++ x86 Redistributable for Visual Studio 2015](http://www.microsoft.com/en-us/download/details.aspx?id=48145) prior to running the game. For those on a 64-bit operating system, grab the x64 redistributable as well. [DirectX End-User Runtimes (June 2010)](http://www.microsoft.com/en-us/download/details.aspx?id=8109) is also required. Windows 7 is the minimum supported version.
* Mac OS X users need to have Mac OS X 10.6.8 or higher to run StepMania.
* Linux users should receive all they need from the package manager of their choice.

##Installing from Source##

StepMania can be compiled using [CMake](http://www.cmake.org/). More information about using CMake can be found in both the `Build` directory and CMake's documentation.

##Build Status##

We currently have two integration servers in place. Their statuses are listed below.

* Travis (Linux): [![Build Status](https://travis-ci.org/stepmania/stepmania.svg?branch=master)](https://travis-ci.org/stepmania/stepmania)
* AppVeyor (Windows): [![Build status](https://ci.appveyor.com/api/projects/status/e932dk2o3anki27p?svg=true)](https://ci.appveyor.com/project/wolfman2000/stepmania-wm87c)

##Resources##

* Website: http://www.stepmania.com/
* IRC: irc.freenode.net/#stepmania-devs
* Theming Wiki: http://goo.gl/SO7W5
* Lua Documentation for Themes: http://goo.gl/XNiov

##Licensing Terms##

* All of the our source code is under the [MIT license](http://opensource.org/licenses/MIT).
* Any songs that are included within this repository are under the [<abbr title="Creative Commons Non-Commercial">CC-NC</abbr> license](https://creativecommons.org/).
* The [MAD library](http://www.underbit.com/products/mad/) and [FFmpeg codecs](https://www.ffmpeg.org/) when built with our code use the [GPL license](http://www.gnu.org).
Update README.md a bit 2014-02-08 13:19:46 -08:00			`StepMania`
Create README.md 2013-12-01 14:37:41 -08:00			`=========`

Introduce cmake (min 2.8.12) to StepMania. 2014-10-17 21:23:00 -04:00			`StepMania is an advanced cross-platform rhythm game for home and arcade use.`

Update README.md a bit 2014-02-08 13:19:46 -08:00			`Advanced cross-platform rhythm game for home and arcade use.`

Generate Windows binaries once more. 2015-10-25 13:52:35 -04:00			`##Installing from Setup/Installer##`

			`For those that do not wish to compile the game on their own and use a binary right away, be aware of the following issues:`

Update README.md. 2015-10-31 20:16:28 +08:00			`* Windows users are expected to have installed the [Microsoft Visual C++ x86 Redistributable for Visual Studio 2015](http://www.microsoft.com/en-us/download/details.aspx?id=48145) prior to running the game. For those on a 64-bit operating system, grab the x64 redistributable as well. [DirectX End-User Runtimes (June 2010)](http://www.microsoft.com/en-us/download/details.aspx?id=8109) is also required. Windows 7 is the minimum supported version.`
Generate Windows binaries once more. 2015-10-25 13:52:35 -04:00			`* Mac OS X users need to have Mac OS X 10.6.8 or higher to run StepMania.`
			`* Linux users should receive all they need from the package manager of their choice.`

Introduce cmake (min 2.8.12) to StepMania. 2014-10-17 21:23:00 -04:00			`##Installing from Source##`

Update README.md 2015-06-02 11:28:36 -04:00			StepMania can be compiled using [CMake](http://www.cmake.org/). More information about using CMake can be found in both the `Build` directory and CMake's documentation.
Introduce cmake (min 2.8.12) to StepMania. 2014-10-17 21:23:00 -04:00
			`##Build Status##`

Add the AppVeyor (window) status. 2015-10-05 17:42:22 -04:00			`We currently have two integration servers in place. Their statuses are listed below.`
Introduce cmake (min 2.8.12) to StepMania. 2014-10-17 21:23:00 -04:00
Add the AppVeyor (window) status. 2015-10-05 17:42:22 -04:00			`* Travis (Linux): [![Build Status](https://travis-ci.org/stepmania/stepmania.svg?branch=master)](https://travis-ci.org/stepmania/stepmania)`
...have a link to the PROPER build. 2015-10-25 08:06:12 -04:00			`* AppVeyor (Windows): [![Build status](https://ci.appveyor.com/api/projects/status/e932dk2o3anki27p?svg=true)](https://ci.appveyor.com/project/wolfman2000/stepmania-wm87c)`
add compile status from travis-ci; thanks @shakesoda 2014-08-01 05:05:42 -05:00
Introduce cmake (min 2.8.12) to StepMania. 2014-10-17 21:23:00 -04:00			`##Resources##`
Update README.md a bit 2014-02-08 13:19:46 -08:00
something something markdown parsing newlines as continuations 2014-02-08 15:41:14 -06:00			`* Website: http://www.stepmania.com/`
			`* IRC: irc.freenode.net/#stepmania-devs`
Introduce cmake (min 2.8.12) to StepMania. 2014-10-17 21:23:00 -04:00			`* Theming Wiki: http://goo.gl/SO7W5`
			`* Lua Documentation for Themes: http://goo.gl/XNiov`

			`##Licensing Terms##`

			`* All of the our source code is under the [MIT license](http://opensource.org/licenses/MIT).`
			`* Any songs that are included within this repository are under the [<abbr title="Creative Commons Non-Commercial">CC-NC</abbr> license](https://creativecommons.org/).`
Update README.md 2015-06-02 11:28:36 -04:00			`* The [MAD library](http://www.underbit.com/products/mad/) and [FFmpeg codecs](https://www.ffmpeg.org/) when built with our code use the [GPL license](http://www.gnu.org).`