From fc8a43f3745e7f3808e29b90a2fa9a958ecaf29b Mon Sep 17 00:00:00 2001 From: Daniel Karbach Date: Tue, 9 Oct 2012 18:02:52 +0200 Subject: [PATCH] added readme file this contains some instructions for building and launching as well as pointers to the wiki, bugtracker, me, myself, and I. --- readme | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 readme diff --git a/readme b/readme new file mode 100644 index 0000000..6bb9cb0 --- /dev/null +++ b/readme @@ -0,0 +1,28 @@ +About + l2e is a 2D tiling RPG engine with turn-based gameplay in maps and battles. + Its long-term goal is feature-completeness with Lufia 2. + +Quickstart + cd Release; make all; cd ..; ./Release/l2e test-data/*.l2s + +Building + To build the binary, simply enter the desired build configuration directory + (currently `Release' or `Debug') and execute `make all`. + +Launching + The current version required 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. + Those can be passed as arguments from the command line. + + By default, main() will launch a map scene. + This can be changed to a battle scene by passing `-B'. + +More + There is a project page online with issue tracker and wiki at + `http://luke.redirectme.net/redmine/projects/l2e'. + + You may file bug reports and/or feature requests at any time. + Pull-requests and patches also welcome. + Contact address is `daniel.karbach@localhorst.tv'. -- 2.39.2