diff options
author | jeannekamikaze <jeannekamikaze@gmail.com> | 2012-07-31 14:29:57 +0300 |
---|---|---|
committer | jeannekamikaze <jeannekamikaze@gmail.com> | 2012-07-31 14:29:57 +0300 |
commit | 865556ece4d26ab912b7be623b5e284332faa1ae (patch) | |
tree | 713cab42978c0071aad6d9c06eaceb455fe7f1bb | |
parent | f8205d7d70d5edd953e3efd77abb8c67dc95db94 (diff) |
Update README.md
Initial readme file.
-rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
@@ -0,0 +1,24 @@ | |||
1 | Spear | ||
2 | ===== | ||
3 | |||
4 | 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. | ||
5 | |||
6 | 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. | ||
7 | |||
8 | Installation | ||
9 | ------------ | ||
10 | |||
11 | Simply clone the repo and build with cabal: | ||
12 | |||
13 | ``` | ||
14 | git clone https://github.com/jeannekamikaze/Spear.git | ||
15 | cd Spear | ||
16 | cabal install | ||
17 | ``` | ||
18 | |||
19 | Documentation | ||
20 | ------------- | ||
21 | |||
22 | An online copy of the haddocks can be found [here][0]. | ||
23 | |||
24 | [0]: http://shellblade.net/docs/Spear/index.html | ||