Dogcows Code - chaz/yoink/blob - README

   1
   2 Yoink - The alien-smashing action game
   3 --------------------------------------
   4
   5 Contents:
   6
   7 I.   Users
   8   a)   General information
   9   b)   Requirements
  10   c)   License
  11 II.  Developers
  12   a)   Notes regarding the code
  13   b)   Sending patches
  14 III. Packagers
  15   a)   The build system
  16
  17
  18 I. Users
  19 --------
  20
  21 a) General information
  22
  23 Yoink is a game created by Neil Carter for Mac OS.  You play the part of a
  24 flying alien heroine who must defend her home on Earth from other airborne
  25 alien invaders.
  26
  27 This version of the game uses all new code and modern frameworks to bring
  28 this simple, fast-moving action game to a wider audience.
  29
  30 b) Requirements
  31
  32 boost headers
  33 libpng
  34 libvorbis
  35 Lua
  36 OpenAL
  37 OpenGL (including GLU)
  38 pkgconfig
  39 SDL
  40
  41 c) License
  42
  43 The new code is released under the 2-clause BSD license.  The old code and
  44 original resources are provided under the zlib/libpng License.  See the
  45 file COPYING for complete details.  The full texts of applicable licenses
  46 can be found in doc/licenses/.
  47
  48
  49 II. Developers
  50 --------------
  51
  52 a) Notes regarding the code
  53
  54 The code is a complete rewrite, containing none of the original code.  I've
  55 made some effort to put the more generic or reusable code into a separate
  56 library called Moof.  I've also made an effort to incorporate 3rd-party
  57 code that happened to fit well into what I needed.  So, generally, the
  58 source code is separated into these three categories:
  59
  60 1. Yoink-specific code.
  61
  62 This is the code directly in src/.  These classes reside in no namespace.
  63
  64 2. Reusable code.
  65
  66 Currently, the code is in src/Moof/, and it is compiled as a convenience
  67 library.  These classes and helper functions reside in the Mf namespace.
  68 Since I wrote this code alongside the Yoink-specific stuff, there is
  69 somewhat of a blurry line between the two categories, unfortunately.
  70
  71 3. Third-party code.
  72
  73 This is made up of free code from other projects or libraries (aside from
  74 the explicit dependencies above), the licenses of which are also in the
  75 COPYING file.  This code resides in various namespaces and in various
  76 subdirectories.
  77
  78 b) Sending patches
  79
  80 I'll gladly entertain patches if you want to fix bugs or whatnot.  Just
  81 email me your stuff or tell me where to pull from (git).  If you're
  82 interested in that, please observe the following:
  83
  84 *  Stick to the coding style of the source code files you edit.  Follow the
  85    general style of method and variable naming, as well as white space
  86    formatting.  In particular, use literal tabs with an assumed tabstop of
  87    4 characters.  Also, limit line lengths to 75 characters.
  88
  89 *  For legal reasons, don't include other peoples' code with your patch.
  90    You must also agree to license your changes according to the same terms
  91    and conditions as the files you edit, usually the 2-clause BSD license.
  92
  93 *  If you want your name and contact information in the file AUTHORS,
  94    please make it so in the patch you provide.
  95
  96
  97 III. Packagers
  98 --------------
  99
 100 a) The build system
 101
 102 You can probably tell that the build system of this package is built from
 103 autoconf and automake.  It should be fairly sane.  If you find any
 104 packaging-related problems or code which doesn't compile cleanly on your
 105 platform, feel free to send patches.
 106