Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
nhartland committed Jul 27, 2018
1 parent 5d2cfbc commit 7b2a3c0
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
golflike
========

# golflike
For those who like their golf *procedurally generated*.
<p align="center">
<img width="693" height="385" src="https://i.imgur.com/bcsGrSo.png">
</p>

**golflike** is an attempt at making a coffee-break golf-themed roguelike. It
features a randomly generated 9-hole course, with three different environment
themes. Games are very short, mostly taking less than ten minutes.

**Very much a WIP**.

Requirements
------------
From luarocks:
- lcurses
- date
- forma
- 30log
**Very much a WIP**

Best played in an 81x24 terminal.
Getting the game
----------------

Getting running
---------------
**golflike** can be played either in a terminal or as a Löve application.
Note the terminal version uses the standard 16-colour palette of your terminal.

Terminal **golflike** can be obtained via LuaRocks:

```Shell
lua(jit) main.lua
luarocks install golflike
```

Löve **golflike** can be downloaded from the releases page.

0 comments on commit 7b2a3c0

Please sign in to comment.