X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fyoink;a=blobdiff_plain;f=README;h=39092e738866da52b9bcdede7322b63ee0e5ad6c;hp=0193c48f71a21d4b25711902e9b8110b6d85d4ea;hb=25aefe01ef7dbdb603c51411e04b0d6a6107684f;hpb=838bc00015eb7f583c7cf4b3b1007697bf047da1 diff --git a/README b/README index 0193c48..39092e7 100644 --- a/README +++ b/README @@ -10,14 +10,38 @@ 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. - Dependencies: -boost headers 1.35.0 -libGL -libSDL 1.2.13 -libSDL_image 1.2.7 +boost headers +OpenGL (libGL, libGL or opengl32, glu32) +libSDL +libSDL_image (with libpng support) +libSDL_sound (with libogg support) +libopenal +libalut + + +Notes regarding the 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. -Note: The version numbers are the versions I have been using for development, -not necessarily the minimum required version numbers. +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.