This commit is contained in:
Paul Reeves 2023-02-06 13:00:40 +01:00
parent afb2eac521
commit 63bbbfa564
2 changed files with 21 additions and 5 deletions

.gitignore vendored
View File

@ -1,9 +1,10 @@

View File

@ -1,21 +1,36 @@
# MyFirstUDRKit
Welcome to MyFirstUDRKit. As you can tell from the name, this plugin is not intended for production use. It is just to play with. When you are ready feel free to fork it and give it a new name.
### Forking the repository
For test purposes you can just clone the repo and try building and testing the code. However, for serious work it is recommended that you clone the repo and give the project a new name. When doing so be sure to search and replace all references to MyFirstUDRKit to your new project name. There are two strings to replace:
### Setting up cmake
Run the cmake gui and fill in the path information. Set the source to the root of the location where you have cloned the repo. CMake looks for the file `CMakeLists.txt`. Binaries will be built under `build/x86_64-windows` and `build/x86_64-linux` for linux.
![cmake - pre-config](docs/cmake_before_config.png "cmake pre-config")
![cmake - pre-config](docs/images/cmake_before_config.png "cmake pre-config")
Click on Configure to generate the default config for the current platform. When prompted choose the `Unix makefiles` generator for linux and `Visual Studio 2019`or later for windows
You should then see a screen like this:
![cmake - config](docs/cmake_config.png "cmake config")
![cmake - config](docs/images/cmake_config.png "cmake config")
The only change needed at this stage is to set `CMAKE_BUILD_TYPE to `Debug`
You can then click on `Generate` and you should end up with a screen similar to this:
![cmake - config](docs/images/cmake_generate.png "cmake generate")
If you want to start again be sure to click on `FILE|DELETE CACHE`