+YOINK_README(7) Miscellaneous Information Manual YOINK_README(7)
-Yoink - The alien-smashing action game
---------------------------------------
+NAME
+ yoink_readme -- general information about yoink
-Contents:
+DESCRIPTION
+ Yoink is a game created by Neil Carter for Mac OS. You play the part of
+ a flying alien heroine who must defend her home on Earth from other
+ airborne alien invaders.
-I. Users
- a) General information
- b) Requirements
- c) License
-II. Developers
- a) Notes regarding the code
- b) Sending patches
-III. Packagers
- a) The build system
- b) Targeting Win32
+ This version of the game uses all new code and modern frameworks to bring
+ this simple, fast-moving action game to a wider audience.
+ INSTALLATION
+ Installing Yoink is simple. You can typically use commands such as
+ these:
-I. Users
---------
+ cd /path/to/yoink
+ ./configure
+ make && make install
-a) General information
+ This will install Yoink into the /usr/local directory. To run Yoink,
+ issue the command:
-Yoink is a game created by Neil Carter for Mac OS. You play the part of a
-flying alien heroine who must defend her home on Earth from other airborne
-alien invaders.
+ /usr/local/bin/yoink
-This version of the game uses all new code and modern frameworks to bring
-this simple, fast-moving action game to a wider audience.
+ or just yoink if /usr/local/bin is already in your PATH. See
+ yoink_install(7) for a more detailed discussion about the build system
+ and a list of required packages.
-b) Requirements
+ LICENSE
+ The new code is released under the 2-clause BSD license. The old code
+ and original resources are provided under the zlib/libpng license. See
+ the file COPYING for complete details. Other parts are distributed under
+ different licenses. See yoink_license(7) for the full texts of the
+ relevant licenses.
-boost headers
-libpng
-libvorbis
-Lua
-OpenAL
-OpenGL (including GLU)
-pkgconfig
-SDL
+ ABOUT THE CODE
+ The code is a complete rewrite, containing none of the original code.
+ I've made some effort to put the more generic or reusable code into a
+ separate library called libmoof. I've also made an effort to incorporate
+ 3rd-party code that happened to fit well into what I needed. So,
+ generally, the source code is separated into these three categories:
-c) License
+ 1. Yoink-specific code. This is the code in the src directory. These
+ classes reside in no explicit namespace.
-The new code is released under the 2-clause BSD license. The old code and
-original resources are provided under the zlib/libpng License. See the
-file COPYING for complete details. The full texts of applicable licenses
-can be found in doc/licenses/.
+ 2. Reusable code. The code is in src/moof, and it is compiled as a
+ convenience library. These classes and helper functions reside in
+ the moof namespace. Since I wrote this code alongside the Yoink-
+ specific stuff, there is somewhat of a blurry line between the two
+ categories, unfortunately.
+ 3. Third-party code. This is made up of free code from other projects
+ or libraries, the licenses of which are also noted in the COPYING
+ file. This code resides in various namespaces and in various
+ subdirectories of src.
-II. Developers
---------------
+ PACKAGING
+ Here are some tips to help packagers:
-a) Notes regarding the code
+ o The build scripts are written in Lua, so make sure the Lua
+ interpreter is installed. That shouldn't be a problem since Yoink
+ depends on the Lua library anyway.
-The code is a complete rewrite, containing none of the original code. I've
-made some effort to put the more generic or reusable code into a separate
-library called Moof. I've also made an effort to incorporate 3rd-party
-code that happened to fit well into what I needed. So, generally, the
-source code is separated into these three categories:
+ o The Makefile will only work well with GNU make. On some systems,
+ this is installed as gmake.
-1. Yoink-specific code.
+ o The configure script supports most of the useful options that an
+ Autoconf-generated script would have, and the Makefile supports
+ DESTDIR.
-This is the code directly in src/. These classes reside in no namespace.
+ See yoink_install(7) for a more detailed discussion about the build
+ system.
-2. Reusable code.
+ SENDING PATCHES
+ I'll gladly entertain patches if you want to help out. Just email me
+ your stuff or tell me where to pull if you use git. If you're interested
+ in that, please observe the following:
-Currently, the code is in src/Moof/, and it is compiled as a convenience
-library. These classes and helper functions reside in the Mf namespace.
-Since I wrote this code alongside the Yoink-specific stuff, there is
-somewhat of a blurry line between the two categories, unfortunately.
+ o Stick to the coding style of the source code files you edit. Follow
+ the general style of method and variable naming, as well as white
+ space formatting. In particular, use literal tabs with an assumed
+ tabstop of 8 characters. Also, try to limit line lengths to 78
+ characters.
-3. 3rd-party code.
+ o For legal reasons, don't include other peoples' code with your patch.
+ You must also agree to license your changes according to the same
+ terms and conditions as the files you edit, usually the 2-clause BSD
+ license.
-This is made up of free code from other projects or libraries (aside from
-the explicit dependencies above), the licenses of which are also in the
-COPYING file. This code resides in various namespaces and in various
-subdirectories.
-
-b) Sending patches
-
-I'll gladly entertain patches if you want to fix bugs or whatnot. Just
-email me your stuff or tell me where to pull from (git). If you're
-interested in that, please observe the following:
-
-* Stick to the coding style of the source code files you edit. Follow the
- general style of method and variable naming, as well as white spacing
- formatting. In particular, use literal tabs with an assumed tabstop of
- 4 characters. Also, limit line lengths to 75 characters.
-
-* For legal reasons, don't include other peoples' code with your patch.
- You must also agree to license your changes according to the same terms
- and conditions as the files you edit, usually the 2-clause BSD license.
-
-* If you want your name and contact information in the file AUTHORS,
- please just add it in the patch you provide.
-
-
-III. Packagers
---------------
-
-a) The build system
-
-You can probably tell that the build system of this package is built from
-autoconf and automake. It should be fairly sane. If you find any build
-system problems or code which doesn't compile cleanly on your platform,
-feel free to send back patches.
-
-b) Targeting Win32
-
-If you have a working mingw32 toolchain with all the dependencies, you can
-build a win32 binary using a command such as this:
-
-./configure --host=mingw32 --prefix=/usr/mingw32/usr
-
-where mingw32 is the correct name of your toolchain and the prefix points
-to the installation of your toolchain. I maintain an archive of most of
-the dependencies. The package is in the git repository; just unzip it onto
-your toolchain and configure/compile. If everything goes smoothly, you
-should have a new, shiny yoink.exe. You can then build a complete
-installer using "make package" if you have nsis installed.
-
-I haven't tried building with cygwin or mingw32 on an actual Windows
-machine, and I certainly haven't tried to do it with Visual Studio. You're
-on your own if you go that route.
+ o If you want your name and contact information in the AUTHORS file,
+ please make it so in the patch you provide.
+SEE ALSO
+ yoinkrc(5), yoink(6)
+AUTHORS
+ Charles McGarvey chaz@dogcows.com
+NetBSD 5.1.0_PATCH June 14, 2011 NetBSD 5.1.0_PATCH
projects / chaz / yoink / blobdiff