Finish README

.github/workflows/release.yaml

@@ -44,7 +44,7 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: release-dll
-          path: out/install/x86-release/bin/
+          path: out/install/x86-release/
       - name: Download Release VDF
         uses: actions/download-artifact@v4
         with:
@@ -81,11 +81,14 @@ jobs:
         run: |
           $project = (Get-Content -Path Configuration.cmake | Select-String -Pattern "PROJECT_NAME `"([^`"]+)`"").Matches[0].Groups[1].Value
           $tag = $env:GITHUB_REF -replace '^refs/tags/', ''
-          Compress-Archive out/install/x86-release/bin/* $project-${tag}.zip
+          $files = Get-ChildItem -Path out/install/x86-release/ -Exclude *.vdf 
+          Compress-Archive $files $project-${tag}.zip
           Copy-Item out/install/x86-release/$project.vdf $project-${tag}.vdf
-          Compress-Archive out/install/x86-relwithdebinfo/bin/* $project-${tag}-RelWithDebInfo.zip
+          $files = Get-ChildItem -Path out/install/x86-relwithdebinfo/ -Exclude *.vdf
+          Compress-Archive $files $project-${tag}-RelWithDebInfo.zip
           Copy-Item out/install/x86-relwithdebinfo/$project.vdf $project-${tag}-RelWithDebInfo.vdf
-          Compress-Archive out/install/x86-minsizerel/bin/* $project-${tag}-MinSizeRel.zip
+          $files = Get-ChildItem -Path out/install/x86-minsizerel/ -Exclude *.vdf
+          Compress-Archive $files $project-${tag}-MinSizeRel.zip
           Copy-Item out/install/x86-minsizerel/$project.vdf $project-${tag}-MinSizeRel.vdf
           $prerelease = if (-not ($tag -match '^v?(\d+\.\d+\.\d+)$')) { 'true' } else { 'false' }
           echo "prerelease=${prerelease}" >> $env:GITHUB_OUTPUT

LICENSE.md

@@ -0,0 +1,14 @@
+Copyright 2024 Piotr Macha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the “Software”), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -130,7 +130,12 @@ Nek    Set-UnionApiVersion     Nek\Set-UnionApiVersion [version] Sets the Union
 
 ```
 
-To get help for some command, run `Get-Help Nek\NameOfCommand` with the command name. 
+To get help for some command, run `Get-Help Nek\NameOfCommand` with the command name.
+
+#### Clear build directory
+
+The best solution for CMake issues is to clear the output directory with its cache. You can do it either manually by
+deleting `out` directory or using `Nek/Clear-Build` command.
 
 #### Updating Union API dependency
 
@@ -247,6 +252,18 @@ every engine version. That's way the includes are in one file, and you should no
 inside them. Including external files (like `YourProjectName/`) is fine and files in it should have `#pragma once`
 or include guards.
 
+### Gothic UserAPI
+
+Gothic UserAPI files are included by Gothic API in that order:
+
+```
+userapi/
+<Union API>/ZenGin/Gothic_UserAPI/
+```
+
+The local directory takes precedence over the default directory so you only have to copy the files you would like
+to override. Full list of available files: https://gitlab.com/union-framework/gothic-api/-/tree/main/ZenGin/Gothic_UserAPI
+
 ### Disable or limit multiplatform
 
 If you would like to build the project only for a single engine or a limited set of engines, disable them using `Configuration.cmake`.
@@ -310,4 +327,14 @@ set_target_properties(${PLUGIN_LIBRARY} PROPERTIES
 # VCPKG/Conan
 #   # Setup VCPKG or Conan separately, the template doesn't have any shortcuts
 #   target_link_libraries(${PLUGIN_LIBRARY} PRIVATE SomeLib::SomeTarget)
-```
+```
+
+## License
+
+The template is licensed under [MIT License](LICENSE.md). 
+
+[union-api](https://gitlab.com/union-framework/union-api)
+and [gothic-api](https://gitlab.com/union-framework/gothic-api) are licensed
+under [GNU GENERAL PUBLIC LICENSE V3](https://gitlab.com/union-framework/union-api-/blob/main/LICENSE).
+
+GothicVDFS 2.6 [Copyright (c) 2001-2003, Nico Bendlin, Copyright (c) 1994-2002, Peter Sabath / TRIACOM Software GmbH](vdf/GothicVFS.License.txt)