new language, new compiler

[l2e.git] / readme

diff --git a/readme b/readme
index 4bd0f98ad209c2b5ef204d3a3ea9ae438f975bb6..e10a6c39c103eb0517587407ac1e2d3e52d7fe13 100644 (file)
--- a/readme
+++ b/readme
@@ -3,14 +3,50 @@ About
        Its long-term goal is feature-completeness with Lufia 2.
 
 Quickstart
-       cd Release; make all; cd ..; ./Release/l2e test-data/*.l2s
+       cd build/release; make all; ./l2e ../../test-data/*.l2s
 
 Building
        To build the binary, simply enter the desired build configuration directory
-       (currently `Release' or `Debug') and execute `make all`.
+       in `build' (currently `release' or `debug') and execute `make all`.
+
+       The supplied `config.mk' includes `local-config.mk' should it exist.
+       This can be used to adjust the build configuration to your environment
+       without messing with files tracked by git.
+
+       All built files can be removed via the `clean' make target.
+
+       There are a number of silent includes in the makefiles should you need to
+       override any settings.
+        * Global build settings can be adjusted in `/build/local-config.mk'.
+        * Settings specific to building the l2e binary should go into
+          `/build/l2e-local.mk'.
+        * Build confiuration specific settings should go into
+          `/build/$config/local.mk', e.g. `/build/debug/local.mk'.
+
+       Unit tests can be built with `make tests' and run with `make test'.
+       If a unit test should fail for you, please file a bug at
+       http://luke.redirectme.net/redmine/projects/l2e/issues/new and describe
+        * your architecture and operating system,
+        * versions of the libs,
+        * and which test(s) failed.
+       Patches are also welcome :)
+
+Dependencies
+       Runtime
+        * SDL
+        * SDL_image
+       Building with make and supplied configuration
+        * g++
+        * find
+        * make
+        * pkg-config
+        * and a number of core utilities such as rm, mkdir, and an sh-compatible
+          shell.
+       Building and running unit tests
+        * cppunit
 
 Launching
-       The current version required huge amounts of symbols to be defined and does
+       The current version requires huge amounts of symbols to be defined and does
        not automatically load anything.
        There are some data files in the `test-data' directory that provide exactly
        what's needed to run.
@@ -29,6 +65,8 @@ Control Mapping
        right     : right shift | debug 3   : 3
        left      : left shift  | debug 4   : 4
 
+       This mapping is defined in `src/keys.h'.
+
 More
        There is a project page online with issue tracker and wiki at
        `http://luke.redirectme.net/redmine/projects/l2e'.