X-Git-Url: http://git.localhorst.tv/?a=blobdiff_plain;f=readme;h=cfef816069af088ba1646e75ca6f5858bbbebcb3;hb=5cbe0ba11d6fe180f49101547f05e7fe586d55c0;hp=4bd0f98ad209c2b5ef204d3a3ea9ae438f975bb6;hpb=eab988f0611ebb3fc6fc9eebda5c3f9b89c2ae3c;p=l2e.git diff --git a/readme b/readme index 4bd0f98..cfef816 100644 --- a/readme +++ b/readme @@ -3,11 +3,37 @@ 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; ./2e ../../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'. + +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. Launching The current version required huge amounts of symbols to be defined and does