diff --git a/README.md b/README.md index 83c468f..45960bb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ # haskelloids A small game written in Haskell using my own game engine "Affection". + +![How it looks](screenshot.png) + +## Build instructions + +I recommend highly to use cabal sandboxes for building this project. + +### Dependencies + +to build this you need a working Haskell build environment and following +development libraries: + +* sdl2 +* libglew + +You will also need the engine package itself, which can be obtained at +[its own repo](https://github.com/nek0/affection). YOu cann add it to your +by invoking `cabal sandbox add-source `. + +To install all haskell package dependencies, invoke +`cabal install --only-dependencies`. + +This will take quite some time. Be patient. + +### Building + +If all is well, you can invoke `cabal build` and watch everything come together. + +## Running + +To run the game, just execute the binary `dist/build/haskelloids/haskelloids` in +your build location. diff --git a/haskelloids.cabal b/haskelloids.cabal index 6a72335..9792085 100644 --- a/haskelloids.cabal +++ b/haskelloids.cabal @@ -10,7 +10,7 @@ name: haskelloids -- PVP summary: +-+------- breaking API changes -- | | +----- non-breaking API additions -- | | | +--- code changes with no API change -version: 0.0.0.0 +version: 0.0.0.1 -- A short (one-line) description of the package. synopsis: A little game using Affection diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..04e0783 Binary files /dev/null and b/screenshot.png differ