nek0/haskelloids
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

update readme

Browse source
This commit is contained in:
nek0 2020-05-04 21:53:53 +02:00
parent de77724135
commit 79095b5b20
1 changed files with 4 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -6,8 +6,6 @@ A small game written in Haskell using my own game engine "Affection".
## Build instructions ## Build instructions
I recommend highly to use cabal sandboxes for building this project.
### Dependencies ### Dependencies
to build this you need a working Haskell build environment and following to build this you need a working Haskell build environment and following
@ -18,21 +16,16 @@ development libraries:
You will also need the engine package itself, which can be obtained at 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 [its own repo](https://github.com/nek0/affection). You cann add it to your
by invoking `cabal sandbox add-source <path>`. project by cloning it and adjust the path to it in the file `cabal.project`.
To install all haskell package dependencies, invoke
`cabal install --only-dependencies`.
This will take quite some time. Be patient.
### Building ### Building
If all is well, you can invoke `cabal build` and watch everything come together. If all is well, you can invoke `cabal new-build` and watch everything come
together.
## Running ## Running
To run the game, just execute the binary `dist/build/haskelloids/haskelloids` in To run the game, just invoke `cabal new-run` in the project folder.
your build location.
### Controls ### Controls