Skip to content

Commit

Permalink
#156: README.rst -> README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ozkriff committed Nov 18, 2017
1 parent 3b6f147 commit 6ef09cb
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 91 deletions.
86 changes: 86 additions & 0 deletions README.md
@@ -0,0 +1,86 @@

# Zemeroth

[![][img_license]][LICENSE-MIT]
[![][img_loc]][loc]
[![][img_travis-ci]][travis-ci]
[![][img_appveyor-ci]][appveyor-ci]
[![][img_circle-ci]][circle-ci]

[img_license]: https://img.shields.io/badge/license-MIT_or_Apache_2.0-blue.svg
[img_loc]: https://tokei.rs/b1/github/ozkriff/zemeroth
[img_travis-ci]: https://travis-ci.org/ozkriff/zemeroth.svg?branch=master
[img_appveyor-ci]: https://ci.appveyor.com/api/projects/status/rsxn9wh9xbpey26m/branch/master?svg=true
[img_circle-ci]: https://circleci.com/gh/ozkriff/zemeroth/tree/master.svg?style=svg

[loc]: https://github.com/Aaronepower/tokei
[travis-ci]: https://travis-ci.org/ozkriff/zemeroth
[appveyor-ci]: https://ci.appveyor.com/project/ozkriff/zemeroth
[circle-ci]: https://circleci.com/gh/ozkriff/zemeroth


News: <https://twitter.com/ozkriff>

Devlog album: <http://imgur.com/a/SMVqO>


## Downloads

Precompiled binaries for Linux, Windows, OS X and Android:
<https://github.com/ozkriff/zemeroth/releases>


## Overview

Zemeroth is a turn-based hexagonal tactical game written in [Rust].

![](https://i.imgur.com/myVVfUW.png)

![](https://i.imgur.com/oXpIvb9.png)

![](https://i.imgur.com/ovrTxqy.gif)

![](https://i.imgur.com/VJaXQEJ.gif)

[Rust]: https://rust-lang.org



## Assets

Game assets are stored in a separate repo:
https://github.com/ozkriff/zemeroth_assets

Run `git clone https://github.com/ozkriff/zemeroth_assets assets`
to download them.


## Building

`cargo build`.


## Running

`cargo run`.


## Android

For instructions on setting up your environment see
<https://github.com/tomaka/android-rs-glue#setting-up-your-environment>.

Then run `./do_android` script:

![android screenshot](https://i.imgur.com/T9EgPR1.png)


## License

Zemeroth is distributed under the terms of both
the MIT license and the Apache License (Version 2.0).

See [LICENSE-APACHE] and [LICENSE-MIT] for details.

[LICENSE-MIT]: LICENSE-MIT
[LICENSE-APACHE]: LICENSE-APACHE
91 changes: 0 additions & 91 deletions README.rst

This file was deleted.

0 comments on commit 6ef09cb

Please sign in to comment.