Skip to content

Commit

Permalink
add README and FAQ files
Browse files Browse the repository at this point in the history
the README is also visible here: http://github.com/spring/spring
see for reference: http://en.wikipedia.org/wiki/README
  • Loading branch information
hoijui committed Mar 3, 2010
1 parent 5ad5723 commit 980eabf
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
8 changes: 8 additions & 0 deletions FAQ
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Spring RTS game engine

FAQ

Have a look at FAQ page (http://springrts.com/wiki/FAQs),
and if it does not serve you, ask for help in the forum under:
http://spring.clan-sy.com/phpbb/viewforum.php?f=11

42 changes: 42 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
Spring RTS game engine

README

Spring (formerly TASpring) is an Open Source Real Time Strategy game engine.
Visit our project homepage at http://springrts.com for help, suggestions,
bugs, community forum and everything spring related.

Compiling

Detailed instructions for how to compile Spring can be found here:
http://springrts.com/wiki/Building_spring
The most simple set of commands will be:
> cmake .
> make

Installation

Usually, you want to use an installer or a package prepared for your OS.
Windows: http://springrts.com/wiki/Download
Linux: http://springrts.com/wiki/SetupGuide

If you want to compile and install from source, please see:
http://springrts.com/wiki/Building_spring
The most simple set of commands will be:
> make install

Using

Use a lobby client for playing single- or multi-player matches.
A list of lobbies may be foudn here:
http://springrts.com/wiki/Lobby_Development#Lobby_client_development

Once you are in-game, Spring games basically work like every other RTS,
though it has a LOT of additional ways of controll and customizability:
http://springrts.com/wiki/Using_Spring

Notes

A more extensive readme can be found here:
http://springrts.com/wiki/Read_Me_First

0 comments on commit 980eabf

Please sign in to comment.