X-Git-Url: http://git.draconx.ca/gitweb/liblbx.git/blobdiff_plain/fba9c8ad290c71471cdb8b52d1c5f0e4eb1fb83e..6f5932b1718f364b28227ac83be8749346f61b39:/README

diff --git a/README b/README
new file mode 100644
index 0000000..a2d4a21
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+2ooM: The Master of Orion Reverse Engineering Project
+
+liblbx - library and tools for handling Moo2 data files.
+
+IMPORTANT NOTE: The library is under heavy development, and the API may be
+subject to frequent changes.  Probably not a good idea for it to be used in
+external programs, yet.
+
+Requirements:
+- A C99 compiler
+- The tools themselves currently require some GNU library features, this should
+  change in the future.
+- The lbximg tool requires libpng-1.2
+
+The configure script will attempt to autodetect the presence of the above; if
+it fails to work for some reason, paths can be specified manually.
+
+Currently, the library makes some assertions about the format of input files;
+it will print error messages to stderr if they fail.  This is intended to help
+find exceptions to the current format specs.  Pass --disable-assert to
+configure if you do not wish for these messages to be printed.  Eventually,
+when format specs are believed to be correct, these will be removed.