Dogcows Code - chaz/yoink/blob - 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 COPYING file for complete details.  The full texts of applicable
  35      licenses can be found in doc/licenses within the Yoink package.
  36
  37    ABOUT THE CODE
  38      The code is a complete rewrite, containing none of the original code.
  39      I've made some effort to put the more generic or reusable code into a
  40      separate library called libmoof.  I've also made an effort to incorporate
  41      3rd-party code that happened to fit well into what I needed.  So,
  42      generally, the source code is separated into these three categories:
  43
  44      1.   Yoink-specific code.  This is the code in the src directory.  These
  45           classes reside in no explicit namespace.
  46
  47      2.   Reusable code.  The code is in src/moof, and it is compiled as a
  48           convenience library.  These classes and helper functions reside in
  49           the moof namespace.  Since I wrote this code alongside the Yoink-
  50           specific stuff, there is somewhat of a blurry line between the two
  51           categories, unfortunately.
  52
  53      3.   Third-party code.  This is made up of free code from other projects
  54           or libraries, the licenses of which are also noted in the COPYING
  55           file.  This code resides in various namespaces and in various
  56           subdirectories of src.
  57
  58    PACKAGING
  59      Here are some tips to help packagers:
  60
  61      o   The build scripts are written in Lua, so make sure the Lua
  62          interpreter is installed.  That shouldn't be a problem since Yoink
  63          depends on the Lua library anyway.
  64
  65      o   The Makefile will only work well with GNU make.  On some systems,
  66          this is installed as gmake.
  67
  68      o   The configure script supports most of the useful options that an
  69          Autoconf-generated script would have, and the Makefile supports
  70          DESTDIR.
  71
  72      See yoink_install(7) for a more detailed discussion about the build
  73      system.
  74
  75    SENDING PATCHES
  76      I'll gladly entertain patches if you want to help out.  Just email me
  77      your stuff or tell me where to pull if you use git.  If you're interested
  78      in that, please observe the following:
  79
  80      o   Stick to the coding style of the source code files you edit.  Follow
  81          the general style of method and variable naming, as well as white
  82          space formatting.  In particular, use literal tabs with an assumed
  83          tabstop of 4 characters.  Also, try to limit line lengths to 75
  84          characters.
  85
  86      o   For legal reasons, don't include other peoples' code with your patch.
  87          You must also agree to license your changes according to the same
  88          terms and conditions as the files you edit, usually the 2-clause BSD
  89          license.
  90
  91      o   If you want your name and contact information in the AUTHORS file,
  92          please make it so in the patch you provide.
  93
  94 SEE ALSO
  95      yoinkrc(5), yoink(6)
  96
  97 AUTHORS
  98      Charles McGarvey      chaz@dogcows.com
  99
 100 NetBSD 5.1.0_PATCH               June 14, 2011              NetBSD 5.1.0_PATCH