X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fyoink;a=blobdiff_plain;f=README;h=7dba1136d8414e16ee72605864eac17572ab483b;hp=3f99fc6cd9839d2414e9f4170ff2fb049fc96f7a;hb=5918751f97a3eb976a7b24647786109edc58234c;hpb=a31d65a998121df0651c57bfb68782e2a07d2e2f

diff --git a/README b/README
index 3f99fc6..7dba113 100644
--- a/README
+++ b/README
@@ -1,18 +1,37 @@
 
-Yoink is a game originally developed 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.
+Yoink - The alien-smashing action game
+--------------------------------------
+
+Contents:
+
+I.   Users
+  a)   General information
+  b)   Requirements
+  c)   License
+II.  Developers
+  a)   Notes regarding the code
+  b)   Porting
+III. Packagers
+  a)   The build system
+  b)   Help requested
+
+
+I. Users
+--------
+
+a) General information
+
+Yoink is a game originally developed 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.
 
 This version of the game uses all new code and modern frameworks to bring
 this simple, fast-moving action game to a wider audience.
 
-The new code is released under the BSD-2 license.  The old code and original
-resources are provided under the zlib/libpng License.  See COPYING for complete
-details.
-
-Dependencies:
+b) Requirements
 
-boost headers
+boost
+headers
 freealut
 libvorbis
 Lua
@@ -21,14 +40,24 @@ OpenGL
 SDL
 SDL_image (with libpng support)
 
+c) License
+
+The new code is released under the BSD-2 license.  The old code and
+original resources are provided under the zlib/libpng License.  See COPYING
+for complete details.  The full texts of applicable licenses can be found
+in doc/licenses/.
+
 
-Notes regarding the code:
+II. Developer
+-------------
 
-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:
+a) Notes regarding 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 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:
 
 1. Yoink-specific code.
 
@@ -37,13 +66,39 @@ This is the code directly in src/.  These classes reside in no namespace.
 2. Reusable code.
 
 Currently, the code is in src/Moof/, and it is compiled as a convenience
-library.  These classes and other 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.
+library.  These classes and other 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.
 
 3. 3rd-party code.
 
-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.
+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) Porting
+
+Portability is a goal of this project.  To this end, Yoink is written in
+standard C++ and takes advantage of cross-platform libraries.  If code
+changes are required to cleanly build Yoink on your platform, please send
+back patches.
+
+
+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
+problems, especially any bugs which complicate packaging on certain
+systems, please send back patches.
+
+b) Help requested
+
+If you can create packages for your favorite platform, please send them
+back to me and/or place the package in a public repository appropriate for
+your distribution or platform.  I would especially appreciate packages in
+common formats such as deb, rpm, or OS X app bundles.