Skip to content

Commit

Permalink
More updates on build instructions + fix CI
Browse files Browse the repository at this point in the history
  • Loading branch information
myst6re committed Aug 9, 2024
1 parent f3f1150 commit 9deaece
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 76 deletions.
54 changes: 0 additions & 54 deletions .vsconfig

This file was deleted.

1 change: 0 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
36 changes: 15 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit 9deaece

Please sign in to comment.