Update the README.md files with newer and more useful information

fixes #4
This commit is contained in:
mdiluzio 2014-12-20 16:50:57 +00:00
parent f6f6d6fafd
commit 98deae237b
4 changed files with 35 additions and 23 deletions

View file

@ -1,17 +1,27 @@
# TTRTS
*v0.0.1*
*The Tiny Terminal RTS where the players write their AIs*
-------------------------------------------------------------------------------
-----------------------------------------------------------
## Introduction
A simple terminal based RTS game that uses txt files to communicate game state and unit commands. TTRTS was
A simple terminal based RTS game that uses text files to communicate game state and unit commands.
-------------------------------------------------------------------------------
## Gameplay
1. The ttrts client is run from the command line with initial parameters
2. The client outputs a gamestate text file
3. A player, program or cat reads the state and outputs instructions for their units.
4. The client reads in instructions and processes the turn
5. If no winner is reached, skip back to step 2
6. The game client outputs a final summary file with the winner
TTRTS was is from the ground up designed to be a fun way to practice programming. Any programming language than can handle file I/O can be used to make an AI for TTRTS, and this extensibility allows for any type of programmer to have fun and enjoy designing and playing against their friends.
*see [game](source/game) for full game rules*
-----------------------------------------------------------
## Building TTRTS
#### Requirements
* cmake - our build system uses cmake
* Linux/OSX - currently no support for Windows
#### To Build
$ git clone https://github.com/mdiluz/ttrts.git
$ cd ttrts
$ ./bootstrap.sh
$ ./ttrts # To launch binary and display usage
-----------------------------------------------------------
## Further Information
See [the ttrts binary readme](source/ttrts/README.md) for full usage and game rules