Updated README.md

lpestl · Mar 4, 2024 · d998aa3 · d998aa3
1 parent 3fafeca
commit d998aa3
Show file tree

Hide file tree

Showing 11 changed files with 13 additions and 14 deletions.
diff --git a/Media/00_EmptyWindow.png b/Media/00_EmptyWindow.png
diff --git a/Media/04_WinNewWindow.png b/Media/04_WinNewWindow.png
diff --git a/Media/1.jpg b/Media/1.jpg
diff --git a/Media/2.jpg b/Media/2.jpg
diff --git a/Media/3.jpg b/Media/3.jpg
diff --git a/Media/4.jpg b/Media/4.jpg
diff --git a/Media/slate-format-text.png b/Media/slate-format-text.png
diff --git a/Media/starship-colors.png b/Media/starship-colors.png
diff --git a/Media/starship-icons.png b/Media/starship-icons.png
diff --git a/Media/starship-widgets.png b/Media/starship-widgets.png
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # UnrealSlateAppTemplate #
 
-Project template for creating cross-platform desktop applications based on [Unrial Engine 4](https://www.unrealengine.com/). For the GUI, the [Slate UI Framework](https://docs.unrealengine.com/en-US/ProgrammingAndScripting/Slate/index.html) (part of UE4) is used.
+Project template for creating cross-platform desktop applications based on [Unrial Engine](https://www.unrealengine.com/). For the GUI, the [Slate UI Framework](https://docs.unrealengine.com/en-US/ProgrammingAndScripting/Slate/index.html) (part of UnrealEngine) is used.
 
 ## Description ## 
 
@@ -14,23 +14,14 @@ As far as I know, there is currently no easy way to generate such an almost empt
 
 ![Empty window](Media/00_EmptyWindow.png)
 
-## Slate UI Gallery ##
-
-All screenshots are taken from the open [Gerke Max Preussner portfolio](https://gmpreussner.com/portfolio/slate-ui)
-
-* ![UE4](Media/1.jpg)
-* ![Reflector 1](Media/2.jpg)
-* ![Reflector 2](Media/3.jpg)
-* ![SlateViewer](Media/4.jpg)
-
 ## Requirements ##
 
-1) In order for the "TemplateRenamer" Tool in the form of a script to run correctly, you need to install [Python 3](https://www.python.org/downloads/) (tested with 3.8.5):
+1) In order for the "TemplateRenamer" Tool in the form of a script to run correctly, you need to install [Python 3](https://www.python.org/downloads/) (tested with 3.8, 3.9, 3.12):
     * Windows - https://www.python.org/downloads/windows/
     * Linux - https://www.python.org/downloads/source/
     * MacOS - https://www.python.org/downloads/mac-osx/
-2) In order for the project to be generated, compiled and run after renaming, you need to have an up-to-date version of [Unrial Engine 4](https://www.unrealengine.com/) (tested on 4.24, 4.25 and 4.26) compiled from [sources from GitHub](https://github.com/EpicGames/UnrealEngine) (**Release** branch is recommended). For this, there is a detailed instruction from EpicGames: 
-    * [How do I access Unreal Engine 4 C++ source code via GitHub?](https://www.unrealengine.com/en-US/ue4-on-github)
+2) In order for the project to be generated, compiled and run after renaming, you need to have an up-to-date version of [Unrial Engine](https://www.unrealengine.com/) (tested on 5.2, 5.3) compiled from [sources from GitHub](https://github.com/EpicGames/UnrealEngine) (**Release** branch is recommended). For this, there is a detailed instruction from EpicGames: 
+    * [How do I access Unreal Engine C++ source code via GitHub?](https://www.unrealengine.com/en-US/ue-on-github)
     * [Downloading Unreal Engine Source Code](https://docs.unrealengine.com/en-US/ProgrammingAndScripting/ProgrammingWithCPP/DownloadingSourceCode/index.html)
     * [Building Unreal Engine from Source](https://docs.unrealengine.com/en-US/ProductionPipelines/DevelopmentSetup/BuildingUnrealEngine/index.html)
 
@@ -46,10 +37,18 @@ In order to get a new project with a new name, you need to do the following:
 |:------------|:-----------|
 | ![Win console](Media/01_winconsole.png) | ![Linux console](Media/02_linuxconsole.png) |
 
-4) Go to the folder with the newly created project, right-click on the `*.uproject` file and select "*Generate project files*" (there are alternative ways for the command line, [more details here](https://docs.unrealengine.com/en-US/ProductionPipelines/BuildTools/UnrealBuildTool/ProjectFilesForIDEs/index.html))
+4) Go to the folder with the newly created project, right-click on the `*.uproject` file and select "*Switch Unreal Engine version*" or "*Generate project files*" (there are alternative ways for the command line, [more details here](https://docs.unrealengine.com/en-US/ProductionPipelines/BuildTools/UnrealBuildTool/ProjectFilesForIDEs/index.html))
 5) Now open your IDE for which the project was generated, select the project to start, and after compilation, you will see an empty window. 
 
 ![New window](Media/04_WinNewWindow.png)
 
 Note: It is important to understand that at the first compilation, building the project can take a long time, since IDE tries to index the entire source code of the engine, as well as build the modules that are included in the dependencies. In the future, if you do not change the engine code, then the dependent modules will not be rebuilt, which means that the assembly of your project will be faster.
 
+## Slate UI Gallery ##
+
+All screenshots are taken from base app **SlateViewer**
+
+* ![Slate Starship widgets](Media/starship-widgets.png)
+* ![Starship icons](Media/starship-icons.png)
+* ![Slate text format](Media/slate-format-text.png)
+* ![Base starship theme colors](Media/starship-colors.png)