From 9deaece10be378588eb04bcb4e0666d0678d8c9a Mon Sep 17 00:00:00 2001 From: myst6re Date: Fri, 9 Aug 2024 10:53:09 +0200 Subject: [PATCH] More updates on build instructions + fix CI --- .vsconfig | 54 -------------------------------------------------- CMakeLists.txt | 1 - README.md | 36 ++++++++++++++------------------- 3 files changed, 15 insertions(+), 76 deletions(-) delete mode 100644 .vsconfig diff --git a/.vsconfig b/.vsconfig deleted file mode 100644 index f9f1b76..0000000 --- a/.vsconfig +++ /dev/null @@ -1,54 +0,0 @@ -{ - "version": "1.0", - "components": [ - "Microsoft.VisualStudio.Component.CoreEditor", - "Microsoft.VisualStudio.Workload.CoreEditor", - "Microsoft.NetCore.Component.Runtime.3.1", - "Microsoft.NetCore.Component.SDK", - "Microsoft.VisualStudio.Component.NuGet", - "Microsoft.Net.Component.4.6.1.TargetingPack", - "Microsoft.VisualStudio.Component.Roslyn.Compiler", - "Microsoft.VisualStudio.Component.Roslyn.LanguageServices", - "Microsoft.VisualStudio.Component.FSharp", - "Microsoft.NetCore.Component.DevelopmentTools", - "Microsoft.VisualStudio.ComponentGroup.WebToolsExtensions", - "Microsoft.Net.Component.4.8.SDK", - "Microsoft.Net.Component.4.7.2.TargetingPack", - "Microsoft.Net.ComponentGroup.DevelopmentPrerequisites", - "Microsoft.VisualStudio.Component.TypeScript.3.8", - "Microsoft.VisualStudio.Component.JavaScript.TypeScript", - "Microsoft.Component.MSBuild", - "Microsoft.VisualStudio.Component.TextTemplating", - "Microsoft.VisualStudio.Component.SQL.CLR", - "Microsoft.VisualStudio.Component.ManagedDesktop.Core", - "Microsoft.Net.Component.4.5.2.TargetingPack", - "Microsoft.Net.Component.4.5.TargetingPack", - "Microsoft.VisualStudio.Component.IntelliCode", - "Microsoft.Net.Component.4.TargetingPack", - "Microsoft.Net.Component.4.5.1.TargetingPack", - "Microsoft.Net.Component.4.6.TargetingPack", - "Microsoft.Net.ComponentGroup.TargetingPacks.Common", - "Microsoft.Net.Core.Component.SDK.2.1", - "Microsoft.VisualStudio.Component.DiagnosticTools", - "Microsoft.VisualStudio.Component.EntityFramework", - "Microsoft.VisualStudio.Component.Debugger.JustInTime", - "Microsoft.VisualStudio.Component.VC.CoreIde", - "Microsoft.VisualStudio.Component.Windows10SDK", - "Microsoft.VisualStudio.Component.VC.Tools.x86.x64", - "Microsoft.VisualStudio.Component.Graphics.Tools", - "Microsoft.VisualStudio.Component.VC.DiagnosticTools", - "Microsoft.VisualStudio.Component.ManagedDesktop.Prerequisites", - "Microsoft.ComponentGroup.Blend", - "Microsoft.VisualStudio.Workload.ManagedDesktop", - "Microsoft.VisualStudio.Component.VC.Redist.14.Latest", - "Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Core", - "Microsoft.VisualStudio.ComponentGroup.WebToolsExtensions.CMake", - "Microsoft.VisualStudio.Component.VC.CMake.Project", - "Microsoft.VisualStudio.Component.VC.ATL", - "Microsoft.VisualStudio.Component.VC.TestAdapterForBoostTest", - "Microsoft.VisualStudio.Component.VC.TestAdapterForGoogleTest", - "Microsoft.VisualStudio.Component.VC.ASAN", - "Microsoft.VisualStudio.Workload.NativeDesktop", - "Microsoft.VisualStudio.Component.Windows10SDK.19041" - ] -} \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index fc7d17e..2887374 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -73,7 +73,6 @@ add_compile_definitions( ) find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Widgets OpenGLWidgets OpenGL LinguistTools REQUIRED) -set(ZLIB_USE_STATIC_LIBS ON) find_package(ZLIB REQUIRED) find_package(lz4 REQUIRED) diff --git a/README.md b/README.md index 658d561..5d565b6 100644 --- a/README.md +++ b/README.md @@ -20,44 +20,38 @@ instructions below. ### Windows -#### Qt +#### Required: Qt 0) Download the online installer from https://www.qt.io/download-qt-installer ( remember to click the Download button ) 1) Install Qt with these items checked: - **Packages categories:** `Latest supported releases` - **Components:** Uncheck everything and pick `Qt/Qt 6.*.*/MSVC 20?? 64-bit` - - [Optionnal] To open the project with Qt Creator (easier), check `Developer and Designer Tools/Qt Creator`, `Developer and Designer Tools/CMake` and `Developer and Designer Tools/Ninja` + - [Optional] To open the project with Qt Creator (easier), check `Developer and Designer Tools/Qt Creator` and `Developer and Designer Tools/CMake` -#### Qt Creator +#### Required: MSVC Compiler -Open the project and setup Qt. Select Debug or Release build and then run the project (CTRL + R). +0) Download the the latest [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/) installer (2019 or 2022 depending of what you checked when installing Qt) +1) Run the installer, check "Desktop developement C++", or per component, at least: + - `Compiler/MSVC C++ x64/86` (last version) + - [Optional] To open the project with Visual Studio or Visual Studio Code, check `Compiler/CMake C++ Tools for Windows`, `Dev/Base C++ features`, `Dev/IntelliCode` -To deploy the project with Qt dependencies you can add an extra "cmake install" step in "Run settings" of the project. +#### Optional: Qt Creator (easier) -#### Visual Studio +Open the project (`File` > `Open File or Project...` > `CMakeLists.txt`) and setup Qt. Select Debug or Release build and then run the project (`CTRL + R`). -> **Please note:** -> -> By default Visual Studio will pick the **x64-Release** build configuration, but you can choose any other profile available. +To deploy the project with Qt dependencies you can add an extra "cmake install" step in "Run settings" of the project. -0) **REQUIRED!** Follow the steps to install Qt, if you didn't already -0) Download the the latest [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/) installer -1) Run the installer and import this [.vsconfig](.vsconfig) file in the installer to pick the required components to build this project -2) Once installed, open this repository **as a folder** in Visual Studio 2019 and click the build button. +#### Optional: Visual Studio -To execute the project you need Qt dependencies where the exe is created. You can either: -```sh -cmake --install {cmake_build_dir} -``` -Or +Open this repository **as a folder** and click the build button. + +To execute the project you need Qt dependencies where the exe is created. You can do (replace `{QT_DIR}` by where Qt is installed): ```sh {QT_DIR}/*/msvc2019_64/bin/windeployqt --no-quick-import -xml --translations en {build_dir} ``` #### Optional: Visual Studio Code -0) **REQUIRED!** Follow the steps to install Qt, if you didn't already -0) **REQUIRED!** Follow the steps to install Visual Studio, if you didn't already 1) Download and install the latest [Visual Studio Code](https://code.visualstudio.com/) release 2) Install the following extensions: - https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools @@ -66,7 +60,7 @@ Or 4) Choose as build profile in the status bar `CMake: [Release]` ( or one of the aforementioned profiles ) 5) Click the button on the status bar `Build` -To execute the project, follow the instructions from "Visual Studio" section. +To execute the project, follow the instructions from "Optional: Visual Studio" section. ### macOS