small build system tweaks

[chaz/yoink] / README

diff --git a/README b/README
index 1b66b52090e3b2cf3222adcafd21d87ce764af73..3f99fc6cd9839d2414e9f4170ff2fb049fc96f7a 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,49 @@
 
-Yoink is a game originally developed by Neil Carter for Mac OS X.  You play
-the part of a flying alien heroine who must defend her home on Earth from
-other airborne alien invaders.
+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 rewritten code and modern frameworks to bring
+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 Simplified BSD License.  The old code and
-original resources are provided under the zlib/libpng License.  See COPYING
-for complete details.
+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:
+
+boost headers
+freealut
+libvorbis
+Lua
+OpenAL
+OpenGL
+SDL
+SDL_image (with libpng support)
+
+
+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.
+
+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.
+
+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.