Browse Source

Fixed Readme, added licenses for cmake scripts

Thomas Buck 10 years ago
parent
commit
0b677d3a82
4 changed files with 77 additions and 29 deletions
  1. 10
    4
      README.md
  2. 22
    2
      cmake/FindALUT.cmake
  3. 22
    11
      cmake/FindSDL2.cmake
  4. 23
    12
      cmake/FindSDL2TTF.cmake

+ 10
- 4
README.md View File

@@ -43,7 +43,7 @@ On Mac OS X 10.9 with [XCode](https://developer.apple.com/xcode/) and [MacPorts]
43 43
 
44 44
 A similar command for the package manager of your favorite Linux Distribution should do the trick.
45 45
 
46
-cmake is only needed to build [freealut](https://github.com/vancegroup/freealut), which you'll need to enable sound output on Mac OS X.
46
+cmake is also needed to build [freealut](https://github.com/vancegroup/freealut), which you'll need to enable sound output on Mac OS X.
47 47
 Get, compile and install freealut like this:
48 48
 
49 49
     git clone git@github.com:vancegroup/freealut.git
@@ -60,9 +60,13 @@ Linux Distributions will probably provide an ALUT library ready to install with
60 60
 If you installed the dependencies using MacPorts, you'll need to have `/opt/local/bin` in your `$PATH` before you can execute make.
61 61
 If you're using Bash, the MacPorts installer should have automatically edited your configuration.
62 62
 
63
-Just run `make debug` and run `bin/debug/OpenRaider` for a debug build.
64
-`make release` builds a release binary.
65
-`make bundle` creates a Mac App Bundle that also runs the setup script, if necessary.
63
+Just do a cmake out-of-tree build and specify if you want the Debug or Release configuration, then run the resulting executable:
64
+
65
+    mkdir build
66
+    cd build
67
+    cmake -DCMAKE_BUILD_TYPE=Debug ..
68
+    make
69
+    ./OpenRaider
66 70
 
67 71
 ## Usage
68 72
 
@@ -215,6 +219,8 @@ The included sample WAV file is made from the [Falling Mate ringtone](http://bre
215 219
 
216 220
 The included Unit Test Framework [greatest](https://github.com/silentbicycle/greatest/) by Scott Vokes is licensed under the [ISC License](http://www.isc.org/downloads/software-support-policy/isc-license/).
217 221
 
222
+The included cmake scripts [FindALUT](https://github.com/rpavlik/cmake-modules/blob/master/FindALUT.cmake), [FindSDL2](https://github.com/dhewm/dhewm3/blob/master/neo/sys/cmake/FindSDL2.cmake) and [FindSDL2TTF](https://github.com/Deraen/ohj2710/blob/master/cmake_modules/FindSDL2TTF.cmake) are released under the Boost Software License (for FindALUT) and under the BSD License for the other two. Authors: Ryan Pavlik, Iowa State University, Eric Wing and Kitware Inc.
223
+
218 224
 OpenRaider is based on code, specs, and alogrithms from:
219 225
 
220 226
 + GooseEgg/Freyja 3d Modelers by Mongoose

+ 22
- 2
cmake/FindALUT.cmake View File

@@ -26,8 +26,28 @@
26 26
 #
27 27
 # Copyright Iowa State University 2009-2010.
28 28
 # Distributed under the Boost Software License, Version 1.0.
29
-# (See accompanying file LICENSE_1_0.txt or copy at
30
-# http://www.boost.org/LICENSE_1_0.txt)
29
+#
30
+# Permission is hereby granted, free of charge, to any person or organization
31
+# obtaining a copy of the software and accompanying documentation covered by
32
+# this license (the "Software") to use, reproduce, display, distribute,
33
+# execute, and transmit the Software, and to prepare derivative works of the
34
+# Software, and to permit third-parties to whom the Software is furnished to
35
+# do so, all subject to the following:
36
+# 
37
+# The copyright notices in the Software and this entire statement, including
38
+# the above license grant, this restriction and the following disclaimer,
39
+# must be included in all copies of the Software, in whole or in part, and
40
+# all derivative works of the Software, unless such copies or derivative
41
+# works are solely in the form of machine-executable object code generated by
42
+# a source language processor.
43
+# 
44
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
45
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
46
+# FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
47
+# SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
48
+# FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
49
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
50
+# DEALINGS IN THE SOFTWARE.
31 51
 
32 52
 set(ALUT_ROOT_DIR
33 53
 	"${ALUT_ROOT_DIR}"

+ 22
- 11
cmake/FindSDL2.cmake View File

@@ -51,19 +51,30 @@
51 51
 # This needed to change because "proper" SDL convention
52 52
 # is #include "SDL.h", not <SDL2/SDL.h>. This is done for portability
53 53
 # reasons because not all systems place things in SDL2/ (see FreeBSD).
54
-
55
-#=============================================================================
54
+# 
55
+# =============================================================================
56 56
 # Copyright 2003-2009 Kitware, Inc.
57 57
 #
58
-# Distributed under the OSI-approved BSD License (the "License");
59
-# see accompanying file Copyright.txt for details.
60
-#
61
-# This software is distributed WITHOUT ANY WARRANTY; without even the
62
-# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
63
-# See the License for more information.
64
-#=============================================================================
65
-# (To distribute this file outside of CMake, substitute the full
66
-#  License text for the above reference.)
58
+# Redistribution and use in source and binary forms, with or without
59
+# modification, are permitted provided that the following conditions are met: 
60
+# 
61
+# 1. Redistributions of source code must retain the above copyright notice, this
62
+#    list of conditions and the following disclaimer. 
63
+# 2. Redistributions in binary form must reproduce the above copyright notice,
64
+#    this list of conditions and the following disclaimer in the documentation
65
+#    and/or other materials provided with the distribution. 
66
+# 
67
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
68
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
69
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
70
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
71
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
72
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
73
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
74
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
75
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
76
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
77
+# =============================================================================
67 78
 
68 79
 SET(SDL2_SEARCH_PATHS
69 80
 	~/Library/Frameworks

+ 23
- 12
cmake/FindSDL2TTF.cmake View File

@@ -51,19 +51,30 @@
51 51
 # This needed to change because "proper" SDL convention
52 52
 # is #include "SDL.h", not <SDL2/SDL.h>. This is done for portability
53 53
 # reasons because not all systems place things in SDL2/ (see FreeBSD).
54
-
55
-#=============================================================================
56
-# Copyright 2003-2009 Kitware, Inc.
57 54
 #
58
-# Distributed under the OSI-approved BSD License (the "License");
59
-# see accompanying file Copyright.txt for details.
55
+# =============================================================================
56
+# Copyright 2003-2009 Kitware, Inc.
60 57
 #
61
-# This software is distributed WITHOUT ANY WARRANTY; without even the
62
-# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
63
-# See the License for more information.
64
-#=============================================================================
65
-# (To distribute this file outside of CMake, substitute the full
66
-#  License text for the above reference.)
58
+# Redistribution and use in source and binary forms, with or without
59
+# modification, are permitted provided that the following conditions are met: 
60
+# 
61
+# 1. Redistributions of source code must retain the above copyright notice, this
62
+#    list of conditions and the following disclaimer. 
63
+# 2. Redistributions in binary form must reproduce the above copyright notice,
64
+#    this list of conditions and the following disclaimer in the documentation
65
+#    and/or other materials provided with the distribution. 
66
+# 
67
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
68
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
69
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
70
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
71
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
72
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
73
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
74
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
75
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
76
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
77
+# =============================================================================
67 78
 
68 79
 SET(SDL2TTF_SEARCH_PATHS
69 80
 	~/Library/Frameworks
@@ -160,4 +171,4 @@ ENDIF(SDL2TTF_LIBRARY_TEMP)
160 171
 
161 172
 INCLUDE(FindPackageHandleStandardArgs)
162 173
 
163
-FIND_PACKAGE_HANDLE_STANDARD_ARGS(SDL2TTF REQUIRED_VARS SDL2TTF_LIBRARY SDL2TTF_INCLUDE_DIR)
174
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(SDL2TTF REQUIRED_VARS SDL2TTF_LIBRARY SDL2TTF_INCLUDE_DIR)

Loading…
Cancel
Save