From 63bbbfa564cab25a1a0a85919eb03756d1c38773 Mon Sep 17 00:00:00 2001 From: Paul Reeves Date: Mon, 6 Feb 2023 13:00:40 +0100 Subject: [PATCH] WIP --- .gitignore | 7 ++++--- Readme.md | 19 +++++++++++++++++-- 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 6e26abd..88ab198 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,10 @@ /.cache/ /.vscode/ -/build/CMakeFiles/ -/build/x86_64-linux/ /test/execsql-readme.md /test/recreate_db.ddl /test/testudrkit.txt -/graveyard/broken_code.txt +/graveyard/ /expressions.txt +/build/x86_64-windows/CMakeFiles/ +/build/x86_64-linux/CMakeFiles/ +/build/x86_64-linux/CMakeCache.txt diff --git a/Readme.md b/Readme.md index e343b8a..30ca617 100644 --- a/Readme.md +++ b/Readme.md @@ -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: + +``` +MyFirstUDRKit +MY_FIRST_UDR_KIT +``` ### 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`