diff --git a/README.md b/README.md index 177eafb..0cc62e5 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,26 @@ -golflike -======== - +# golflike For those who like their golf *procedurally generated*. +

+ +

+ +**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.