aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 59a46a04c7969dfb4c3d3878cbefb5fa450873a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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