aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjeannekamikaze <jeannekamikaze@gmail.com>2012-07-31 14:29:57 +0300
committerjeannekamikaze <jeannekamikaze@gmail.com>2012-07-31 14:29:57 +0300
commit865556ece4d26ab912b7be623b5e284332faa1ae (patch)
tree713cab42978c0071aad6d9c06eaceb455fe7f1bb /README.md
parentf8205d7d70d5edd953e3efd77abb8c67dc95db94 (diff)
Update README.md
Initial readme file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..59a46a0 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,24 @@
1Spear
2=====
3
4Spear 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.
5
6The 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.
7
8Installation
9------------
10
11Simply clone the repo and build with cabal:
12
13```
14git clone https://github.com/jeannekamikaze/Spear.git
15cd Spear
16cabal install
17```
18
19Documentation
20-------------
21
22An online copy of the haddocks can be found [here][0].
23
24[0]: http://shellblade.net/docs/Spear/index.html