fixed documentation about where to find licenses
[chaz/yoink] / README
1 YOINK_README(7) Miscellaneous Information Manual YOINK_README(7)
2
3 NAME
4 yoink_readme -- general information about yoink
5
6 DESCRIPTION
7 Yoink is a game created by Neil Carter for Mac OS. You play the part of
8 a flying alien heroine who must defend her home on Earth from other
9 airborne alien invaders.
10
11 This version of the game uses all new code and modern frameworks to bring
12 this simple, fast-moving action game to a wider audience.
13
14 INSTALLATION
15 Installing Yoink is simple. You can typically use commands such as
16 these:
17
18 cd /path/to/yoink
19 ./configure
20 make && make install
21
22 This will install Yoink into the /usr/local directory. To run Yoink,
23 issue the command:
24
25 /usr/local/bin/yoink
26
27 or just yoink if /usr/local/bin is already in your PATH. See
28 yoink_install(7) for a more detailed discussion about the build system
29 and a list of required packages.
30
31 LICENSE
32 The new code is released under the 2-clause BSD license. The old code
33 and original resources are provided under the zlib/libpng license. See
34 the file COPYING for complete details. Other parts are distributed under
35 different licenses. See yoink_license(7) for the full texts of the
36 relevant licenses.
37
38 ABOUT THE CODE
39 The code is a complete rewrite, containing none of the original code.
40 I've made some effort to put the more generic or reusable code into a
41 separate library called libmoof. I've also made an effort to incorporate
42 3rd-party code that happened to fit well into what I needed. So,
43 generally, the source code is separated into these three categories:
44
45 1. Yoink-specific code. This is the code in the src directory. These
46 classes reside in no explicit namespace.
47
48 2. Reusable code. The code is in src/moof, and it is compiled as a
49 convenience library. These classes and helper functions reside in
50 the moof namespace. Since I wrote this code alongside the Yoink-
51 specific stuff, there is somewhat of a blurry line between the two
52 categories, unfortunately.
53
54 3. Third-party code. This is made up of free code from other projects
55 or libraries, the licenses of which are also noted in the COPYING
56 file. This code resides in various namespaces and in various
57 subdirectories of src.
58
59 PACKAGING
60 Here are some tips to help packagers:
61
62 o The build scripts are written in Lua, so make sure the Lua
63 interpreter is installed. That shouldn't be a problem since Yoink
64 depends on the Lua library anyway.
65
66 o The Makefile will only work well with GNU make. On some systems,
67 this is installed as gmake.
68
69 o The configure script supports most of the useful options that an
70 Autoconf-generated script would have, and the Makefile supports
71 DESTDIR.
72
73 See yoink_install(7) for a more detailed discussion about the build
74 system.
75
76 SENDING PATCHES
77 I'll gladly entertain patches if you want to help out. Just email me
78 your stuff or tell me where to pull if you use git. If you're interested
79 in that, please observe the following:
80
81 o Stick to the coding style of the source code files you edit. Follow
82 the general style of method and variable naming, as well as white
83 space formatting. In particular, use literal tabs with an assumed
84 tabstop of 8 characters. Also, try to limit line lengths to 78
85 characters.
86
87 o For legal reasons, don't include other peoples' code with your patch.
88 You must also agree to license your changes according to the same
89 terms and conditions as the files you edit, usually the 2-clause BSD
90 license.
91
92 o If you want your name and contact information in the AUTHORS file,
93 please make it so in the patch you provide.
94
95 SEE ALSO
96 yoinkrc(5), yoink(6)
97
98 AUTHORS
99 Charles McGarvey chaz@dogcows.com
100
101 NetBSD 5.1.0_PATCH June 14, 2011 NetBSD 5.1.0_PATCH
This page took 0.034915 seconds and 4 git commands to generate.