From 865556ece4d26ab912b7be623b5e284332faa1ae Mon Sep 17 00:00:00 2001 From: jeannekamikaze Date: Tue, 31 Jul 2012 14:29:57 +0300 Subject: Update README.md Initial readme file. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index e69de29..59a46a0 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,24 @@ +Spear +===== + +Spear is a simple 3D game framework I have been working on since I started learning Haskell, and is therefore more of a "let's see where I can get to" kind of project. + +The project's goal is to put what I learn into practise, to explore how far I can get with Haskell and if the results are decent enough, to build one or two game demos along the way. + +Installation +------------ + +Simply clone the repo and build with cabal: + +``` +git clone https://github.com/jeannekamikaze/Spear.git +cd Spear +cabal install +``` + +Documentation +------------- + +An online copy of the haddocks can be found [here][0]. + +[0]: http://shellblade.net/docs/Spear/index.html -- cgit v1.2.3