aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsfan5 <sfan5@live.de>2021-03-07 13:24:11 +0100
committersfan5 <sfan5@live.de>2021-03-07 13:25:24 +0100
commit03ad637114ffb255f5b9d36c204072e8d263022f (patch)
treec8704dde328469f1bf02052a60bbcc5c2010bd2e
parent53e09519e22344a211e96c43743d269bbc971b97 (diff)
downloadirrlicht-03ad637114ffb255f5b9d36c204072e8d263022f.tar.xz
Add README
-rw-r--r--README.md61
-rw-r--r--irr-readme.txt (renamed from readme.txt)0
2 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e1f33d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+The Irrlicht engine version 1.9
+===============================
+
+This is a fork of the Irrlicht engine by the [Minetest](https://github.com/minetest) developers that contains features, customizations and fixes specifically for use in Minetest.
+
+Build
+-----
+
+The build system is CMake.
+
+The following libraries are required to be installed:
+* zlib, libPNG, libJPEG
+* OpenGL
+ * or on mobile: OpenGL ES (can be optionally enabled on desktop too)
+* on Unix: X11
+
+Aside from standard search options (`ZLIB_INCLUDE_DIR`, `ZLIB_LIBRARY`, ...) the following options are available:
+* `BUILD_SHARED_LIBS` (default: `ON`) - Build Irrlicht as a shared library
+
+e.g. on a Linux system you might want to build for local use like this:
+
+ git clone https://github.com/minetest/irrlicht
+ cmake . -DBUILD_SHARED_LIBS=OFF
+ make -j$(nproc)
+
+Platforms
+---------
+
+We aim to support these platforms:
+* Windows via MinGW
+* Linux (GL or GLES)
+* macOS
+* Android
+
+This doesn't mean other platforms don't work or won't be supported, if you find something that doesn't work contributions are welcome.
+
+License
+-------
+
+The license of the Irrlicht Engine is based on the zlib/libpng license and applies to this fork, too.
+
+ The Irrlicht Engine License
+ ===========================
+
+ Copyright (C) 2002-2012 Nikolaus Gebhardt
+
+ This software is provided 'as-is', without any express or implied
+ warranty. In no event will the authors be held liable for any damages
+ arising from the use of this software.
+
+ Permission is granted to anyone to use this software for any purpose,
+ including commercial applications, and to alter it and redistribute it
+ freely, subject to the following restrictions:
+
+ 1. The origin of this software must not be misrepresented; you must not
+ claim that you wrote the original software. If you use this software
+ in a product, an acknowledgement in the product documentation would be
+ appreciated but is not required.
+ 2. Altered source versions must be clearly marked as such, and must not be
+ misrepresented as being the original software.
+ 3. This notice may not be removed or altered from any source distribution.
diff --git a/readme.txt b/irr-readme.txt
index 868432b..868432b 100644
--- a/readme.txt
+++ b/irr-readme.txt