Add back LightManager

[irrlicht.git] / README.md

diff --git a/README.md b/README.md
index 243cdea97ef0e72fe234677c077c87f954ece62f..a0c496c6892f067cbec2db609d671ab22a95d055 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,7 +3,8 @@ IrrlichtMt version 1.9
 
 The Irrlicht Engine is an open source realtime 3D engine written in C++.
 
-This is a fork by the [Minetest](https://github.com/minetest) developers that contains features, customizations and fixes specifically for use in Minetest.
+This is a fork by the [Minetest](https://github.com/minetest) developers that was stripped-down and customized specifically for use in Minetest.
+It is intentionally not compatible to upstream and is planned to be eventually absorbed into Minetest.
 
 Build
 -----
@@ -19,6 +20,11 @@ The following libraries are required to be installed:
 Aside from standard search options (`ZLIB_INCLUDE_DIR`, `ZLIB_LIBRARY`, ...) the following options are available:
 * `BUILD_SHARED_LIBS` (default: `ON`) - Build IrrlichtMt as a shared library
 * `BUILD_EXAMPLES` (default: `OFF`) - Build example applications
+* `ENABLE_OPENGL` - Enable OpenGL driver
+* `ENABLE_OPENGL3` (default: `OFF`) - Enable OpenGL 3+ driver
+* `ENABLE_GLES1` - Enable OpenGL ES driver, legacy
+* `ENABLE_GLES2` - Enable OpenGL ES 2+ driver
+* `USE_SDL2` (default: `OFF`) - Use SDL2 instead of native platform device
 
 e.g. on a Linux system you might want to build for local use like this:
 
@@ -27,6 +33,23 @@ e.g. on a Linux system you might want to build for local use like this:
        cmake . -DBUILD_SHARED_LIBS=OFF
        make -j$(nproc)
 
+This will put an IrrlichtMtTargets.cmake file into the cmake directory in the current build directory, and it can then be imported from another project by pointing `find_package()` to the build directory, or by setting the `CMAKE_PREFIX_PATH` variable to that same path.
+
+on Windows system:
+
+It is highly recommended to use vcpkg as package manager.
+
+After you successfully built vcpkg you can easily install the required libraries:
+
+       vcpkg install zlib libjpeg-turbo libpng opengl-registry --triplet x64-windows
+       
+Run the following script in PowerShell:
+
+       git clone https://github.com/minetest/irrlicht
+       cd irrlicht
+       cmake -B build -G "Visual Studio 17 2022" -A "Win64" -DCMAKE_TOOLCHAIN_FILE=[vcpkg-root]/scripts/buildsystems/vcpkg.cmake -DBUILD_SHARED_LIBS=OFF
+       cmake --build build --config Release
+       
 Platforms
 ---------