Update project setup instructions.

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 @@
-Copyright (c) 2012 Marc Sunet

+Copyright (c) 2013, Marc Sunet

 

-Permission 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:

+All rights reserved.

 

-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+Redistribution and use in source and binary forms, with or without

+modification, are permitted provided that the following conditions are met:

 

-THE 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.

+    * Redistributions of source code must retain the above copyright

+      notice, this list of conditions and the following disclaimer.

+

+    * Redistributions in binary form must reproduce the above

+      copyright notice, this list of conditions and the following

+      disclaimer in the documentation and/or other materials provided

+      with the distribution.

+

+    * Neither the name of Marc Sunet nor the names of other

+      contributors may be used to endorse or promote products derived

+      from this software without specific prior written permission.

+

+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

+OF 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
 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

-------------

+Installation (Ubuntu)

+---------------------

 

-Simply clone the repo and build with cabal:

+Install dependencies, then build with cabal:

 

 ```

+$ sudo apt install libxxf86vm-dev libglfw3-dev

 $ git clone https://github.com/jeannekamikaze/Spear.git

 $ cd Spear

-$ cabal install

+$ cabal build

+```

+

+Run a demo:

+

+```

+$ cabal run pong

 ```

 

 Features

diff --git a/Spear.cabal b/Spear.cabal
index 07894c4..81ca38a 100644
--- a/Spear.cabal
+++ b/Spear.cabal
@@ -1,6 +1,6 @@
 name: Spear

 version: 0.1

-cabal-version: >=1.2

+cabal-version: >=1.8

 build-type: Simple

 license: BSD3

 license-file: LICENSE

@@ -115,3 +115,9 @@ library
     ghc-options: -O2

 

     ghc-prof-options: -O2 -fprof-auto -fprof-cafs

+

+executable pong

+  hs-source-dirs:      demos/pong

+  main-is:             Main.hs

+  other-modules:       Pong

+  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 @@
-Copyright (c) 2013, Marc Sunet
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-
-    * Redistributions in binary form must reproduce the above
-      copyright notice, this list of conditions and the following
-      disclaimer in the documentation and/or other materials provided
-      with the distribution.
-
-    * Neither the name of Marc Sunet nor the names of other
-      contributors may be used to endorse or promote products derived
-      from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF 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 @@
-packages: .
-          ../../
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 @@
--- Initial pong.cabal generated by cabal init.  For further documentation,
--- see http://haskell.org/cabal/users-guide/
-
-name:                pong
-version:             0.1.0.0
-synopsis:            A pong clone
--- description:
-license:             BSD3
-license-file:        LICENSE
-author:              Marc Sunet
--- maintainer:
--- copyright:
-category:            Game
-build-type:          Simple
-cabal-version:       >=1.8
-
-executable pong
-  -- hs-source-dirs:      src
-  main-is:             Main.hs
-  other-modules:       Pong
-  build-depends:       base, Spear, OpenGL