Skip to content
Snippets Groups Projects
Commit fa3f5cd9 authored by Simon Oehrl's avatar Simon Oehrl
Browse files

Merge branch 'feature/fix_readme' into 'develop'

update readme for new branch structure and new path

See merge request VR-Group/unreal-development/unrealprojecttemplate!29
parents d0ef10b9 f17e9eb7
No related branches found
No related tags found
No related merge requests found
......@@ -4,7 +4,7 @@ Unreal Engine project template catering to the common use cases at RWTH VR. Cont
## Getting Started
### Add the template
`git clone -b master-4-22 --recurse-submodules https://devhub.vr.rwth-aachen.de/VR-Group/unrealprojecttemplate.git` to your local `UnrealEngine/Templates` directory. If you are using Unreal version 4.21 you need to change the `master-4-22` to `master-4-21`. If you know what you are doing and want the latest features use the `develop-*` branch instead of the `master-*` branches.
`git clone -b master --recurse-submodules https://devhub.vr.rwth-aachen.de/VR-Group/unreal-development/unrealprojecttemplate.git` to your local `UnrealEngine/Templates` directory. If you are using Unreal version 4.21 you need to change the `master` to `deprecated/4-21`. If you know what you are doing and want the latest features use the `develop` branch instead of the `master` branches.
### Create a new project
When creating a new Project using Unreal you can find the template under `New Project -> C++ -> RWTH-VR`. After you created the project, open the project folder in the terminal (git-bash on windows) and run the `setup.sh`. This will remove the git remote of the template and optionally lets you add a new remote. This will allow you to call `update.sh` in the future to merge important changes made in the template back into your project. For more details about updating your project can be found in the wiki.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment