X-Git-Url: http://git.localhorst.tv/?a=blobdiff_plain;f=readme;h=e10a6c39c103eb0517587407ac1e2d3e52d7fe13;hb=HEAD;hp=cfef816069af088ba1646e75ca6f5858bbbebcb3;hpb=9d645a0059d185291f63c1375bd4e5ae844acde6;p=l2e.git diff --git a/readme b/readme index cfef816..e10a6c3 100644 --- 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,9 +42,11 @@ 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 + 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. @@ -55,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'.