]> git.lizzy.rs Git - irrlicht.git/blobdiff - README.md
Fix IGUIElements not getting a tab order because of invisible or disabled parents.
[irrlicht.git] / README.md
index ecd1d1059365313aa914bff61b514fe9681255ed..0d17e194031e4af71f4507b06b8255c8399ce66a 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
 -----
@@ -27,8 +28,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 a cmake/ directory in the current build directory, and it can then be imported from another project by pointing find_package() to the source directory of this project, or by setting the CMAKE_PREFIX_PATH variable to that same path.
+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
 ---------