added first unit test

[l2e.git] / readme

diff --git a/readme b/readme
index cfef816069af088ba1646e75ca6f5858bbbebcb3..ff710ac8ed632975ad7ed2a199e2dd498da3da9d 100644 (file)
--- a/readme
+++ b/readme
@@ -3,7 +3,7 @@ About
        Its long-term goal is feature-completeness with Lufia 2.
 
 Quickstart
-       cd build/release; make all; ./2e ../../test-data/*.l2s
+       cd build/release; make all; ./l2e ../../test-data/*.l2s
 
 Building
        To build the binary, simply enter the desired build configuration directory
@@ -23,6 +23,14 @@ Building
         * 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
@@ -34,6 +42,8 @@ Dependencies
         * 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