Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alxvth authored Sep 26, 2024
1 parent a9394b5 commit 4af5898
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ git clone git@github.com:ManiVaultStudio/ExamplePlugins.git
After unzipping you should have an `ExamplePlugins-master`, after cloning you should have an `ExamplePlugins` folder, after navigating to this folder, continue with the next step.

## Project setup
You'll need to define a `ManiVault_DIR` variable and provide it to CMake, as described in the ManiVault install guide. This variable is used to find your local ManiVault installation and defines an install location for the example plugins.
You'll need to define a `ManiVault_DIR` and setup CMake such that it can fin Qt. The `ManiVault_DIR` variable is used to find your local ManiVault installation and defines an install location for the example plugins.

For Windows, using the CMake GUI:
1. Launch CMake (available here: https://cmake.org/)
Expand All @@ -46,11 +46,9 @@ For Windows, using the CMake GUI:
`Build: C:/YourOwnFolder/ExamplePlugins-master/build`

4. Press `Configure` and select the `Visual Studio 15 2019` (or 17 2022) generator with the optional platform of `x64`. If it is not available, be sure to install Visual Studio. Press Finish to configure the project.
5. CMake should now ask you to provide an `ManiVault_DIR` path that points to where ManiVault is installed. Double click the `ManiVault_DIR` variable and press the small button on the right to browse to the folder where ManiVault Studio is installed. (The folder containing either or both the Debug and Release folder).
![image](https://github.com/ManiVaultStudio/ExamplePlugins/assets/2978176/8f082e77-d90d-45fb-bc0d-e0b8a5a634f3)

6. A lot of red paths should now appear. Check that the ones pointing to Qt directories seem correct and then press `Generate` to generate the Visual Studio solution. If it is asking you for a Qt6_DIR please refer to [CMake cannot find my Qt Installation](https://github.com/ManiVaultStudio/PublicWiki/wiki/FAQ#cmake-cannot-find-my-qt-installation).
7. Press `Open Project` to launch Visual Studio and the example project.
![Example_cmake](https://github.com/user-attachments/assets/b86e6e19-0fc1-40ec-8397-04e5ee8a7f87)
5. A lot of red paths should now appear. Set the `ManiVault_DIR` to the subfolder of your ManiVault install directory (which should hold `Debug`, `Release` and a `cmake` folder) that contains a `ManiVaultConfig.cmake` file. That should be `YOUR_MANIVAULT_INSTALL_DIR/cmake/mv`. Check that the entries relating to Qt seem correct and then press `Generate` to generate the Visual Studio solution. If cmake is asking you for a Qt6_DIR please refer to [CMake cannot find my Qt Installation](https://github.com/ManiVaultStudio/PublicWiki/wiki/FAQ#cmake-cannot-find-my-qt-installation).
6. Press `Open Project` to launch Visual Studio and the example project.

## Compiling
For Windows:
Expand Down

0 comments on commit 4af5898

Please sign in to comment.