-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated README and incremented version
- Loading branch information
Showing
3 changed files
with
21 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,37 @@ | ||
# floodr | ||
|
||
FIXME: description | ||
<p align="center"> | ||
<img src="floodr_screenshot01.png" alt="screenshot"/> | ||
</p> | ||
|
||
## Installation | ||
floodr is a game for the unix terminal. The goal is to make your part | ||
of the board as large as possible. It is possible to play alone or | ||
with up to four players, and there is also an AI. | ||
|
||
Download from http://example.com/FIXME. | ||
This was mostly a project for myself to learn some clojure, but now | ||
it's out there for anyone who is interested! | ||
|
||
## Usage | ||
## Installation | ||
|
||
FIXME: explanation | ||
Download the standalone jar from http://example.com/FIXME. | ||
|
||
$ java -jar floodr-0.1.0-standalone.jar [args] | ||
Or clone the repo and use [leiningen](http://leiningen.org/) to run it. | ||
|
||
## Options | ||
|
||
FIXME: listing of options this app accepts. | ||
## Usage | ||
|
||
## Examples | ||
$ java -jar floodr-0.2.0-standalone.jar [args] | ||
|
||
... | ||
However I recommend to create an alias in `~/.bash_aliases` | ||
|
||
### Bugs | ||
alias floodr='java -jar /path/to/floodr-0.2.0-standalone.jar' | ||
|
||
... | ||
## Options | ||
|
||
### Any Other Sections | ||
### That You Think | ||
### Might be Useful | ||
`--swing` if you want to use a GUI terminal. This should only be used | ||
if you don't have `/bin/sh`. | ||
|
||
## License | ||
|
||
Copyright © 2015 FIXME | ||
Copyright © 2015 | ||
|
||
Distributed under the Eclipse Public License either version 1.0 or (at | ||
your option) any later version. | ||
Distributed under the Eclipse Public License version 1.0, the same as clojure. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters