1# Spring RTS game engine
2[![Build Status](https://travis-ci.org/spring/spring.svg?branch=develop)](https://travis-ci.org/spring/spring)
3
4## README
5
6Spring (formerly TASpring) is an Open Source Real Time Strategy game engine.
7Visit our [project homepage](http://springrts.com/) for help, suggestions,
8bugs, community forum and everything spring related.
9
10### Compiling
11
12Detailed instructions for how to compile Spring can be found [here](http://springrts.com/wiki/Building_spring)
13
14The most simple set of commands will be:
15
16	cmake .
17	make
18
19### Installation
20
21Usually, you want to use an installer or a package prepared for your OS:
22
23* Windows: <http://springrts.com/wiki/Download>
24* Linux:   <http://springrts.com/wiki/SetupGuide>
25
26If you want to compile and install from source, please see [this wiki page](http://springrts.com/wiki/Building_spring)
27
28The most simple set of commands will be:
29
30	make install
31
32### Using
33
34Use a lobby client for playing single- or multi-player matches.
35A list of lobbies may be found [here](http://springrts.com/wiki/Lobby_Development#Lobby_client_development)
36
37Once you are in-game, Spring games basically work like every other RTS,
38though it has [a LOT of additional ways of control and customizability](http://springrts.com/wiki/Using_Spring).
39
40### Notes
41
42A more extensive readme can be found [here](http://springrts.com/wiki/Read_Me_First).
43