diff --git a/README.md b/README.md index 5d189a7..9c82b3d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#pituicat +# pituicat This repository contains the source and game design files for the game `pituicat`. @@ -6,18 +6,18 @@ This repository contains the source and game design files for the game This game is still an experimental work in progress, so things are subject to change and no version or revision numbers are being assigned (yet). -##Build and run instructions +## Build and run instructions For any system you want to buil on, you will need a current version of `ghc` as well as the build tool `cabal`. Additional libraries may be needed, depending on your operating system. -###Linux +### Linux I develop this game in [NixOS](https://nixos.org), so the build instructions for this system are the ones I use on a daily basis. -####NixOS +#### NixOS To set up the build environment, simply run this in the command line of your choice: @@ -35,20 +35,20 @@ cabal new-run to compile and run the game. -####Other Linux flavours +#### Other Linux flavours You will need at least the development libraries for `sdl2` and a development setup for `OpenGL`. TODO: provide list of development libraries this game directly depends on. -###Other operating systems +### Other operating systems I wish you good luck with that. If you manage to run the game on other systms, ping me with build and run instructions on and I will gladly include them here. -##Gameplay +## Gameplay Since there is no interactive content yet, there is nothing much to write here other than: enjoy the visuals!