Skip to content

Updated Readme to match what is in CMakePresets.json#39

Open
jbyron1 wants to merge 1 commit intomyst6re:masterfrom
jbyron1:update-readme
Open

Updated Readme to match what is in CMakePresets.json#39
jbyron1 wants to merge 1 commit intomyst6re:masterfrom
jbyron1:update-readme

Conversation

@jbyron1
Copy link
Copy Markdown

@jbyron1 jbyron1 commented Jan 6, 2026

Was trying to build from source on linux and was having problems, realized that the instructions seem to have an additional parent directory above the build and install directories that the CMakePresets.json base preset does not have.

I modified the instructions for linux with the commands that worked for me, i assume the same changes would need to be made to the mac instructions, but i do not have a mac to test with.

@myst6re
Copy link
Copy Markdown
Owner

myst6re commented Jan 6, 2026

Thanks for the PR!

I tested the README on my machine, and ideally the sequence should be:

sudo apt install mono-complete
# + install qt
git submodule update --init
cmake --preset=Debug

This will use the CMakePresets file + vcpkg

CC @julianxhokaxhiu

@julianxhokaxhiu
Copy link
Copy Markdown
Contributor

Overall the PR makes sense to me, but I'd prefer if we use the preset approach instead as it would align to what we do on CI as well, hence providing the end user the same build artifacts we product over here on Github.

I'll add a suggestion to the PR. But thanks for rising it up!

Comment thread README.md
Comment on lines +94 to +96
$ mkdir build install
$ cmake -S . -B build -DCMAKE_INSTALL_PREFIX=install -DCMAKE_BUILD_TYPE=Debug
$ cmake --build build --config Debug
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Preferring .build and .install as paths as they would be automatically ignored by our .gitignore

Suggested change
$ mkdir build install
$ cmake -S . -B build -DCMAKE_INSTALL_PREFIX=install -DCMAKE_BUILD_TYPE=Debug
$ cmake --build build --config Debug
$ mkdir .build .install
$ cmake -B .build --preset=Debug -DCMAKE_INSTALL_PREFIX=.install
# Add the following params if you're building for macOS: -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" -DVCPKG_TARGET_TRIPLET="universal-osx"
$ cmake --build .build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants