aboutsummaryrefslogtreecommitdiff
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
parent3027010b87e30bc1546ff48b9e5011fa3b3e8fb6 (diff)
Update project setup instructions.
Diffstat
-rw-r--r--LICENSE31
-rw-r--r--README.md15
-rw-r--r--Spear.cabal8
-rw-r--r--demos/pong/LICENSE30
-rw-r--r--demos/pong/cabal.project2
-rw-r--r--demos/pong/pong.cabal21
6 files changed, 45 insertions, 62 deletions
diff --git a/LICENSE b/LICENSE
index 037be14..1c80674 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,7 +1,30 @@
1Copyright (c) 2012 Marc Sunet 1Copyright (c) 2013, Marc Sunet
2 2
3Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 3All rights reserved.
4 4
5The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions are met:
6 7
7THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 8 * Redistributions of source code must retain the above copyright
9 notice, this list of conditions and the following disclaimer.
10
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15
16 * Neither the name of Marc Sunet nor the names of other
17 contributors may be used to endorse or promote products derived
18 from this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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
diff --git a/Spear.cabal b/Spear.cabal
index 07894c4..81ca38a 100644
--- a/Spear.cabal
+++ b/Spear.cabal
@@ -1,6 +1,6 @@
1name: Spear 1name: Spear
2version: 0.1 2version: 0.1
3cabal-version: >=1.2 3cabal-version: >=1.8
4build-type: Simple 4build-type: Simple
5license: BSD3 5license: BSD3
6license-file: LICENSE 6license-file: LICENSE
@@ -115,3 +115,9 @@ library
115 ghc-options: -O2 115 ghc-options: -O2
116 116
117 ghc-prof-options: -O2 -fprof-auto -fprof-cafs 117 ghc-prof-options: -O2 -fprof-auto -fprof-cafs
118
119executable pong
120 hs-source-dirs: demos/pong
121 main-is: Main.hs
122 other-modules: Pong
123 build-depends: base, Spear, OpenGL
diff --git a/demos/pong/LICENSE b/demos/pong/LICENSE
deleted file mode 100644
index 2ad9c8d..0000000
--- a/demos/pong/LICENSE
+++ /dev/null
@@ -1,30 +0,0 @@
1Copyright (c) 2013, Marc Sunet
2
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions are met:
7
8 * Redistributions of source code must retain the above copyright
9 notice, this list of conditions and the following disclaimer.
10
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15
16 * Neither the name of Marc Sunet nor the names of other
17 contributors may be used to endorse or promote products derived
18 from this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/demos/pong/cabal.project b/demos/pong/cabal.project
deleted file mode 100644
index 3dc1fca..0000000
--- a/demos/pong/cabal.project
+++ /dev/null
@@ -1,2 +0,0 @@
1packages: .
2 ../../
diff --git a/demos/pong/pong.cabal b/demos/pong/pong.cabal
deleted file mode 100644
index aec96ee..0000000
--- a/demos/pong/pong.cabal
+++ /dev/null
@@ -1,21 +0,0 @@
1-- Initial pong.cabal generated by cabal init. For further documentation,
2-- see http://haskell.org/cabal/users-guide/
3
4name: pong
5version: 0.1.0.0
6synopsis: A pong clone
7-- description:
8license: BSD3
9license-file: LICENSE
10author: Marc Sunet
11-- maintainer:
12-- copyright:
13category: Game
14build-type: Simple
15cabal-version: >=1.8
16
17executable pong
18 -- hs-source-dirs: src
19 main-is: Main.hs
20 other-modules: Pong
21 build-depends: base, Spear, OpenGL
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-21 20:03:43 +0000