aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author3gg <3gg@shellblade.net>2023-03-09 09:44:30 -0800
committer3gg <3gg@shellblade.net>2023-03-09 09:44:30 -0800
commitf688e3b624226ca843a7256987d9a76560a3ab9b (patch)
treed8d05925767b3d8a83da2f7a7fadd48970829beb /README.md
parent3027010b87e30bc1546ff48b9e5011fa3b3e8fb6 (diff)
Update project setup instructions.
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3724fe9..b84b824 100644
--- a/README.md
+++ b/README.md
@@ -5,15 +5,22 @@ Spear is a simple 2.5D game engine I have been working on since I started learni
5The project's goal is to put what I learn into practise, to explore how far I can get with Haskell and if the results 5The project's goal is to put what I learn into practise, to explore how far I can get with Haskell and if the results
6are decent enough, to build one or two game demos along the way. 6are decent enough, to build one or two game demos along the way.
7 7
8Installation 8Installation (Ubuntu)
9------------ 9---------------------
10 10
11Simply clone the repo and build with cabal: 11Install dependencies, then build with cabal:
12 12
13``` 13```
14$ sudo apt install libxxf86vm-dev libglfw3-dev
14$ git clone https://github.com/jeannekamikaze/Spear.git 15$ git clone https://github.com/jeannekamikaze/Spear.git
15$ cd Spear 16$ cd Spear
16$ cabal install 17$ cabal build
18```
19
20Run a demo:
21
22```
23$ cabal run pong
17``` 24```
18 25
19Features 26Features