Import aap/librw @ masterHEADmaster

Snapshot for re3/reVC vendoring, per @lzcnt.
Source: https://github.com/aap/librw (master).

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..77defd0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+librw
+=====
+
+This library is supposed to be a re-implementation of RenderWare graphics,
+or a good part of it anyway.
+
+It is intended to be cross-platform in two senses:
+support rendering on different platforms similar to RW;
+supporting all file formats for all platforms at all times and provide
+way to convert to all other platforms.
+
+Supported file formats are DFF and TXD for PS2, D3D8, D3D9 and Xbox.
+Not all pre-instanced PS2 DFFs are supported.
+BSP is not supported at all.
+
+For rendering we have D3D9 and OpenGL (>=2.1, ES >= 2.0) backends.
+Rendering some things on the PS2 is working as a test only.
+
+# Uses
+
+librw can be used for rendering [GTA](https://github.com/gtamodding/re3).
+
+# Building
+
+Get premake5. Generate a config, e.g. with ``premake5 gmake``,
+and look in the build directory.