Skip to content

Commit

Permalink
docs(README): update README.md
Browse files Browse the repository at this point in the history
Update badge layout.
Add "API Docs" badge to link the crate documentation.
Add "Crates.io" badge to link to the latest crate version on crates.io.
Add "Coverage Status" badge to display the current test coverage status via
coveralls.io.
Update the project summary.
Add a table of contents.
Add a section on precompiled binaries.
Update the section on building and compiling from source.
  • Loading branch information
indiv0 committed May 15, 2016
1 parent 8ba7588 commit 07cd376
Showing 1 changed file with 33 additions and 7 deletions.
40 changes: 33 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,38 @@
# colonize [![Build Status](https://travis-ci.org/indiv0/colonize.svg?branch=master)](https://travis-ci.org/indiv0/colonize)
# colonize

A Dwarf-Fortress/Rogue-like game written in Rust.
<table>
<tr>
<td><strong>Linux / OS X</strong></td>
<td><a href="https://travis-ci.org/indiv0/colonize" title="Travis Build Status"><img src="https://travis-ci.org/indiv0/colonize.svg?branch=master" alt="travis-badge"></img></a></td>
</tr>
<tr>
<td colspan="2">
<a href="https://indiv0.github.io/colonize/colonize" title="API Docs"><img src="https://img.shields.io/badge/API-docs-blue.svg" alt="api-docs-badge"></img></a>
<a href="https://crates.io/crates/colonize" title="Crates.io"><img src="https://img.shields.io/crates/v/colonize.svg" alt="crates-io"></img></a>
<a href="https://coveralls.io/github/indiv0/colonize?branch=master" title="Coverage Status"><img src="https://coveralls.io/repos/github/indiv0/colonize/badge.svg?branch=master" alt="coveralls-badge"></img></a>
</td>
</tr>
</table>

## Prerequisites
A Dwarf-Fortress/Rimworld-like game written in Rust.

# Table of Contents

* [Running Precompiled Binaries](#running-precompiled-binaries)
* [Compiling & Running From Source](#compiling-and-running-from-source)
* [Configuration](#configuration)

## Running Precompiled Binaries

Pre-compiled binaries for each of the major targets can be found on the releases
page, [here][latest-release].

## Compiling & Running From Source
### Prerequisites

* [rust](https://www.rust-lang.org)
* [libtcod](http://roguecentral.org/doryen/libtcod/)

## Compiling
### Compiling

Compiling on Rustc stable:

Expand All @@ -21,7 +46,7 @@ Compiling on Rustc nightly:
cargo build --no-default-features --features nightly
```

## Running
### Running

Running on Rustc stable:

Expand All @@ -47,4 +72,5 @@ the root of this repo as [`colonize.json.example`][colonize-json-example].

In the future, the capability to define the config directory might be added.

[colonize-json-example]: https://github.com/indiv0/colonize/blob/master/colonize.json.example
[colonize-json-example]: https://github.com/indiv0/colonize/blob/master/colonize.json.example "Example configuration"
[latest-release]: https://github.com/indiv0/colonize/releases/latest "Latest release"

0 comments on commit 07cd376

Please sign in to comment.